public class

JoinSpecToGmsConverter

extends java.lang.Object

 java.lang.Object

↳androidx.appsearch.playservicesstorage.converter.JoinSpecToGmsConverter

Gradle dependencies

compile group: 'androidx.appsearch', name: 'appsearch-play-services-storage', version: '1.1.0-alpha05'

  • groupId: androidx.appsearch
  • artifactId: appsearch-play-services-storage
  • version: 1.1.0-alpha05

Artifact androidx.appsearch:appsearch-play-services-storage:1.1.0-alpha05 it located at Google repository (https://maven.google.com/)

Overview

Translates between Gms and Jetpack versions of JoinSpec.

Summary

Methods
public static com.google.android.gms.appsearch.JoinSpectoGmsJoinSpec(JoinSpec jetpackSpec)

Translates a Jetpack JoinSpec into a gms .

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public static com.google.android.gms.appsearch.JoinSpec toGmsJoinSpec(JoinSpec jetpackSpec)

Translates a Jetpack JoinSpec into a gms .

Source

/*
 * Copyright 2024 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.appsearch.playservicesstorage.converter;

import android.annotation.SuppressLint;

import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.appsearch.app.JoinSpec;
import androidx.core.util.Preconditions;

/**
 * Translates between Gms and Jetpack versions of {@link JoinSpec}.
 */
@RestrictTo(RestrictTo.Scope.LIBRARY)
public class JoinSpecToGmsConverter {
    private JoinSpecToGmsConverter() {
    }

    /**
     * Translates a Jetpack {@link JoinSpec} into a gms
     * {@link com.google.android.gms.appsearch.JoinSpec}.
     */
    @SuppressLint("WrongConstant")
    @NonNull
    public static com.google.android.gms.appsearch.JoinSpec toGmsJoinSpec(
            @NonNull JoinSpec jetpackSpec) {
        Preconditions.checkNotNull(jetpackSpec);
        return new com.google.android.gms.appsearch.JoinSpec
                .Builder(jetpackSpec.getChildPropertyExpression())
                .setNestedSearch(
                        jetpackSpec.getNestedQuery(),
                        SearchSpecToGmsConverter.toGmsSearchSpec(
                                jetpackSpec.getNestedSearchSpec()))
                .setMaxJoinedResultCount(jetpackSpec.getMaxJoinedResultCount())
                .setAggregationScoringStrategy(jetpackSpec.getAggregationScoringStrategy())
                .build();
    }
}