1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.room.solver.query.result
18 
19 import androidx.room.solver.CodeGenScope
20 import com.squareup.javapoet.FieldSpec
21 
22 /**
23  * Connects the query, db and the ResultAdapter.
24  * <p>
25  * The default implementation is InstantResultBinder. If the query is deferred rather than executed
26  * directly, such alternative implementations can be implement using this interface (e.g. LiveData,
27  * Rx, caching etc)
28  */
29 abstract class QueryResultBinder(val adapter: QueryResultAdapter?) {
30     /**
31      * receives the sql, bind args and adapter and generates the code that runs the query
32      * and returns the result.
33      */
convertAndReturnnull34     abstract fun convertAndReturn(
35             roomSQLiteQueryVar: String,
36             canReleaseQuery: Boolean, // false if query is provided by the user
37             dbField: FieldSpec,
38             inTransaction: Boolean,
39             scope: CodeGenScope)
40 }
41