blob: f52f7906e3b9ac4245c1555407cd4ec4bc5ded2c [file] [log] [blame]
/*
* Copyright 2021 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
/**
* Repeatable annotation declaring the renamed columns in the [AutoMigration.to] version of
* an auto migration.
*
* @see AutoMigration
*/
@JvmRepeatable(RenameColumn.Entries::class)
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.BINARY)
public annotation class RenameColumn(
/**
* Name of the table in the [AutoMigration.from] version of the database the renamed
* column is found in. The name in [AutoMigration.from] version is used in case the table
* was renamed in the [AutoMigration.to] version.
*
* @return Name of the table
*/
val tableName: String,
/**
* Name of the column in the [AutoMigration.from] version of the database.
*
* @return Name of the column.
*/
val fromColumnName: String,
/**
* Name of the column in the [AutoMigration.to] version of the database.
*
* @return Name of the column.
*/
val toColumnName: String,
) {
/**
* Container annotation for the repeatable annotation [RenameColumn].
*/
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.BINARY)
public annotation class Entries(
vararg val value: RenameColumn
)
}