Skip to content

Commit

Permalink
dataconnect: Rename FirebaseDataConnectExperimental to ExperimentalFi…
Browse files Browse the repository at this point in the history
…rebaseDataConnect (#6433)
  • Loading branch information
dconeybe authored Nov 5, 2024
1 parent 312d14a commit 93640ce
Show file tree
Hide file tree
Showing 23 changed files with 76 additions and 73 deletions.
7 changes: 4 additions & 3 deletions firebase-dataconnect/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@
must implement equals() to be a _logical_ comparsion, rather than just
checking for _referencial_ equality using the `===` operator.
([#6424](https://github.com/firebase/firebase-android-sdk/pull/6424))
* [feature] FirebaseDataConnectExperimental annotation added, and some
* [feature] ExperimentalFirebaseDataConnect annotation added, and some
APIs have been annotated with it, requiring applications that make use of
these experimental APIs to opt-in using
`@OptIn(FirebaseDataConnectExperimental::class)` to suppress warnings or
`@OptIn(ExperimentalFirebaseDataConnect::class)` to suppress warnings or
errors related to using these experimental APIs.
([#6424](https://github.com/firebase/firebase-android-sdk/pull/6424))
([#6424](https://github.com/firebase/firebase-android-sdk/pull/6424)) and
([#6433](https://github.com/firebase/firebase-android-sdk/pull/6433))

# 16.0.0-beta02
* [changed] Updated protobuf dependency to `3.25.5` to fix
Expand Down
50 changes: 25 additions & 25 deletions firebase-dataconnect/api.txt

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
* limitations under the License.
*/

@file:OptIn(FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.connectors.demo

import com.google.firebase.dataconnect.DataConnectException
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.connectors.demo.testutil.DemoConnectorIntegrationTestBase
import com.google.firebase.dataconnect.generated.GeneratedMutation
import com.google.firebase.dataconnect.generated.GeneratedQuery
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
* limitations under the License.
*/

@file:OptIn(FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.connectors.demo

import com.google.firebase.Timestamp
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.MutationResult
import com.google.firebase.dataconnect.OperationResult
import com.google.firebase.dataconnect.connectors.demo.testutil.DemoConnectorIntegrationTestBase
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
* limitations under the License.
*/

@file:OptIn(ExperimentalKotest::class, FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalKotest::class, ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.connectors

import androidx.test.ext.junit.runners.AndroidJUnit4
import com.google.firebase.dataconnect.ConnectorConfig
import com.google.firebase.dataconnect.DataConnectSettings
import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.connectors.demo.DemoConnector
import com.google.firebase.dataconnect.connectors.demo.getInstance
import com.google.firebase.dataconnect.generated.GeneratedConnector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
* limitations under the License.
*/

@file:OptIn(ExperimentalKotest::class, FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalKotest::class, ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.connectors

import androidx.test.ext.junit.runners.AndroidJUnit4
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.connectors.demo.DemoConnector
import com.google.firebase.dataconnect.connectors.demo.getInstance
import com.google.firebase.dataconnect.generated.GeneratedConnector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(FirebaseDataConnectExperimental::class)
@file:OptIn(ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(FlowPreview::class, FirebaseDataConnectExperimental::class)
@file:OptIn(FlowPreview::class, ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ package com.google.firebase.dataconnect
/**
* Marks declarations in the Firebase Data Connect SDK that are **experimental**.
*
* A declaration annotated with [FirebaseDataConnectExperimental] is "experimental": its signature
* A declaration annotated with [ExperimentalFirebaseDataConnect] is "experimental": its signature
* and/or semantics may change in backwards-incompatible ways at any time without notice, up to and
* including complete removal. If you have a use case that relies on such a declaration please open
* a "feature request" issue at https://github.com/firebase/firebase-android-sdk requesting the
Expand All @@ -37,4 +37,4 @@ package com.google.firebase.dataconnect
"\"feature request\" issue at https://github.com/firebase/firebase-android-sdk " +
"requesting this declaration's promotion from \"experimental\" to \"fully-supported\"."
)
public annotation class FirebaseDataConnectExperimental
public annotation class ExperimentalFirebaseDataConnect
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import kotlinx.serialization.modules.SerializersModule
public interface MutationRef<Data, Variables> : OperationRef<Data, Variables> {
override suspend fun execute(): MutationResult<Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun copy(
operationName: String,
variables: Variables,
Expand All @@ -47,14 +47,14 @@ public interface MutationRef<Data, Variables> : OperationRef<Data, Variables> {
variablesSerializersModule: SerializersModule?,
): MutationRef<Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewVariables> withVariablesSerializer(
variables: NewVariables,
variablesSerializer: SerializationStrategy<NewVariables>,
variablesSerializersModule: SerializersModule?,
): MutationRef<Data, NewVariables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
dataSerializersModule: SerializersModule?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ public interface OperationRef<Data, Variables> {
* @see withDataDeserializer
* @see withVariablesSerializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun copy(
operationName: String = this.operationName,
variables: Variables = this.variables,
Expand All @@ -202,7 +202,7 @@ public interface OperationRef<Data, Variables> {
* @see copy
* @see withDataDeserializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun <NewVariables> withVariablesSerializer(
variables: NewVariables,
variablesSerializer: SerializationStrategy<NewVariables>,
Expand All @@ -216,7 +216,7 @@ public interface OperationRef<Data, Variables> {
* @see copy
* @see withVariablesSerializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
dataSerializersModule: SerializersModule? = this.dataSerializersModule,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public interface QueryRef<Data, Variables> : OperationRef<Data, Variables> {
*/
public fun subscribe(): QuerySubscription<Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun copy(
operationName: String,
variables: Variables,
Expand All @@ -58,14 +58,14 @@ public interface QueryRef<Data, Variables> : OperationRef<Data, Variables> {
variablesSerializersModule: SerializersModule?,
): QueryRef<Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewVariables> withVariablesSerializer(
variables: NewVariables,
variablesSerializer: SerializationStrategy<NewVariables>,
variablesSerializersModule: SerializersModule?,
): QueryRef<Data, NewVariables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
dataSerializersModule: SerializersModule?,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@file:OptIn(com.google.firebase.dataconnect.FirebaseDataConnectExperimental::class)
@file:OptIn(com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(com.google.firebase.dataconnect.FirebaseDataConnectExperimental::class)
@file:OptIn(com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(com.google.firebase.dataconnect.FirebaseDataConnectExperimental::class)
@file:OptIn(com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

@file:OptIn(com.google.firebase.dataconnect.FirebaseDataConnectExperimental::class)
@file:OptIn(com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect::class)

package com.google.firebase.dataconnect.core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

package com.google.firebase.dataconnect.generated

import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental

/**
* The interface to be implemented by the over-arching "connector" classes that are generated by the
Expand Down Expand Up @@ -48,7 +48,7 @@ public interface GeneratedConnector<T : GeneratedConnector<T>> {
* This function is essentially the same as the `copy()` method that is generated by the Kotlin
* compiler for `data class` classes.
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun copy(
dataConnect: FirebaseDataConnect = this.dataConnect,
): T
Expand All @@ -63,7 +63,7 @@ public interface GeneratedConnector<T : GeneratedConnector<T>> {
* @see queries
* @see mutations
*/
@FirebaseDataConnectExperimental public fun operations(): List<GeneratedOperation<T, *, *>>
@ExperimentalFirebaseDataConnect public fun operations(): List<GeneratedOperation<T, *, *>>

/**
* Returns a list containing all [GeneratedQuery] objects defined as properties in this object in
Expand All @@ -72,7 +72,7 @@ public interface GeneratedConnector<T : GeneratedConnector<T>> {
* @see operations
* @see mutations
*/
@FirebaseDataConnectExperimental public fun queries(): List<GeneratedQuery<T, *, *>>
@ExperimentalFirebaseDataConnect public fun queries(): List<GeneratedQuery<T, *, *>>

/**
* Returns a list containing all [GeneratedMutation] objects defined as properties in this object
Expand All @@ -81,7 +81,7 @@ public interface GeneratedConnector<T : GeneratedConnector<T>> {
* @see operations
* @see queries
*/
@FirebaseDataConnectExperimental public fun mutations(): List<GeneratedMutation<T, *, *>>
@ExperimentalFirebaseDataConnect public fun mutations(): List<GeneratedMutation<T, *, *>>

/**
* Compares this object with another object for equality.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

package com.google.firebase.dataconnect.generated

import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.MutationRef
import kotlinx.serialization.DeserializationStrategy
import kotlinx.serialization.SerializationStrategy
Expand Down Expand Up @@ -51,20 +51,20 @@ public interface GeneratedMutation<Connector : GeneratedConnector<Connector>, Da
callerSdkType = FirebaseDataConnect.CallerSdkType.Generated
}

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun copy(
connector: Connector,
operationName: String,
dataDeserializer: DeserializationStrategy<Data>,
variablesSerializer: SerializationStrategy<Variables>,
): GeneratedMutation<Connector, Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewVariables> withVariablesSerializer(
variablesSerializer: SerializationStrategy<NewVariables>,
): GeneratedMutation<Connector, Data, NewVariables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
): GeneratedMutation<Connector, NewData, Variables>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

package com.google.firebase.dataconnect.generated

import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.OperationRef
import com.google.firebase.dataconnect.copy
import kotlinx.serialization.DeserializationStrategy
Expand Down Expand Up @@ -78,7 +78,7 @@ public interface GeneratedOperation<Connector : GeneratedConnector<Connector>, D
* @see withDataDeserializer
* @see withVariablesSerializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun copy(
connector: Connector = this.connector,
operationName: String = this.operationName,
Expand All @@ -93,7 +93,7 @@ public interface GeneratedOperation<Connector : GeneratedConnector<Connector>, D
* @see copy
* @see withDataDeserializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun <NewVariables> withVariablesSerializer(
variablesSerializer: SerializationStrategy<NewVariables>,
): GeneratedOperation<Connector, Data, NewVariables>
Expand All @@ -105,7 +105,7 @@ public interface GeneratedOperation<Connector : GeneratedConnector<Connector>, D
* @see copy
* @see withVariablesSerializer
*/
@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
public fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
): GeneratedOperation<Connector, NewData, Variables>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

package com.google.firebase.dataconnect.generated

import com.google.firebase.dataconnect.ExperimentalFirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnect
import com.google.firebase.dataconnect.FirebaseDataConnectExperimental
import com.google.firebase.dataconnect.QueryRef
import kotlinx.serialization.DeserializationStrategy
import kotlinx.serialization.SerializationStrategy
Expand Down Expand Up @@ -51,20 +51,20 @@ public interface GeneratedQuery<Connector : GeneratedConnector<Connector>, Data,
callerSdkType = FirebaseDataConnect.CallerSdkType.Generated
}

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun copy(
connector: Connector,
operationName: String,
dataDeserializer: DeserializationStrategy<Data>,
variablesSerializer: SerializationStrategy<Variables>,
): GeneratedQuery<Connector, Data, Variables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewVariables> withVariablesSerializer(
variablesSerializer: SerializationStrategy<NewVariables>,
): GeneratedQuery<Connector, Data, NewVariables>

@FirebaseDataConnectExperimental
@ExperimentalFirebaseDataConnect
override fun <NewData> withDataDeserializer(
dataDeserializer: DeserializationStrategy<NewData>,
): GeneratedQuery<Connector, NewData, Variables>
Expand Down
Loading

0 comments on commit 93640ce

Please sign in to comment.