AutoMigrationCallback.java

/*
 * 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.migration;
import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.sqlite.db.SupportSQLiteDatabase;

/**
 * Interface for defining automatic migration strategy for Room databases.
 *
 * @hide
 */
// TODO: (b/181655460) Complete code usage documentation for this class and the AutoMigration
//  annotation.
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public interface AutoMigrationCallback {

    /**
     * Handles any changes the user may want to implement after migration is completed.
     */
    default void onPostMigrate(@NonNull SupportSQLiteDatabase db) {}
}