| /* |
| * Copyright 2020 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. |
| */ |
| // @exportToFramework:skipFile() |
| package androidx.appsearch.app; |
| |
| import androidx.annotation.NonNull; |
| import androidx.appsearch.exceptions.AppSearchException; |
| |
| /** |
| * An interface for factories which can convert between data classes and {@link GenericDocument}. |
| * |
| * @param <T> The type of data class this factory converts to and from {@link GenericDocument}. |
| */ |
| public interface DataClassFactory<T> { |
| /** |
| * Returns the name of this schema type, e.g. {@code Email}. |
| * |
| * <p>This is the name used in queries for type restricts. |
| */ |
| @NonNull |
| String getSchemaType(); |
| |
| /** Returns the schema for this data class. */ |
| @NonNull |
| AppSearchSchema getSchema() throws AppSearchException; |
| |
| /** |
| * Converts an instance of the data class into a {@link androidx.appsearch.app.GenericDocument}. |
| */ |
| @NonNull |
| GenericDocument toGenericDocument(@NonNull T dataClass) throws AppSearchException; |
| |
| /** |
| * Converts a {@link androidx.appsearch.app.GenericDocument} into an instance of the data class. |
| */ |
| @NonNull |
| T fromGenericDocument(@NonNull GenericDocument genericDoc) throws AppSearchException; |
| } |