DatabaseViewBundle.kt

/*
 * Copyright 2018 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.room.migration.bundle

import androidx.annotation.RestrictTo

import com.google.gson.annotations.SerializedName

/**
 * Data class that holds the schema information about a
 * {@link androidx.room.DatabaseView DatabaseView}.
 *
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
public open class DatabaseViewBundle(
    @SerializedName("viewName")
    public open val viewName: String,
    @SerializedName("createSql")
    public open val createSql: String
) : SchemaEquality<DatabaseViewBundle> {

    // Used by GSON
    @Deprecated("Marked deprecated to avoid usage in the codebase")
    @SuppressWarnings("unused")
    private constructor() : this("", "")

    /**
     * @return Create view SQL query that uses the actual view name.
     */
    public open fun createView(): String {
        return replaceViewName(createSql, viewName)
    }

    override fun isSchemaEqual(other: DatabaseViewBundle): Boolean {
        return viewName == other.viewName && createSql == other.createSql
    }
}