blob: e77a92759ad4a2deeefad8ad71a1402d44e15958 [file] [log] [blame]
Aurimas Liutikas3aa5a202020-10-05 09:42:14 -07001// Signature format: 4.0
Alan Viveretteba069d52018-03-08 18:02:39 -05002package androidx.room {
shepshapardd2658c62017-11-09 17:44:55 -08003
4 public class DatabaseConfiguration {
Daniel Santiago Rivera38ed8f62018-06-26 13:41:38 -07005 method public boolean isMigrationRequired(int, int);
Jeff Gastonc21caf92018-10-16 13:24:41 -04006 method @Deprecated public boolean isMigrationRequiredFrom(int);
Daniel Santiago Rivera38ed8f62018-06-26 13:41:38 -07007 field public final boolean allowDestructiveMigrationOnDowngrade;
shepshapardd2658c62017-11-09 17:44:55 -08008 field public final boolean allowMainThreadQueries;
Jeff Gaston6edd4a42019-04-12 20:19:05 -04009 field public final java.util.List<androidx.room.RoomDatabase.Callback!>? callbacks;
shepshapardd2658c62017-11-09 17:44:55 -080010 field public final android.content.Context context;
Daniel Santiago Rivera23f47e62019-06-13 15:17:22 -070011 field public final String? copyFromAssetPath;
12 field public final java.io.File? copyFromFile;
Daniel Santiago Rivera1263185e2020-07-31 19:28:39 -070013 field public final java.util.concurrent.Callable<java.io.InputStream!>? copyFromInputStream;
Jeff Gastonc21caf92018-10-16 13:24:41 -040014 field public final androidx.room.RoomDatabase.JournalMode! journalMode;
Alan Viveretteba069d52018-03-08 18:02:39 -050015 field public final androidx.room.RoomDatabase.MigrationContainer migrationContainer;
Yuichi Araki41bbdfb2018-05-23 17:38:58 +090016 field public final boolean multiInstanceInvalidation;
Jeff Gastonc21caf92018-10-16 13:24:41 -040017 field public final String? name;
Daniel Santiago Riveraf5ab17f2020-08-20 09:14:10 -070018 field public final androidx.room.RoomDatabase.PrepackagedDatabaseCallback? prepackagedDatabaseCallback;
Tyson Henningee3fb4b2018-05-16 15:51:37 -070019 field public final java.util.concurrent.Executor queryExecutor;
shepshapardd2658c62017-11-09 17:44:55 -080020 field public final boolean requireMigration;
Alan Viveretteba069d52018-03-08 18:02:39 -050021 field public final androidx.sqlite.db.SupportSQLiteOpenHelper.Factory sqliteOpenHelperFactory;
Daniel Santiago Rivera919986a2019-03-13 16:10:41 -070022 field public final java.util.concurrent.Executor transactionExecutor;
mzgreen7bd7c652020-09-19 06:02:23 +000023 field public final java.util.List<java.lang.Object!> typeConverters;
shepshapardd2658c62017-11-09 17:44:55 -080024 }
25
26 public class InvalidationTracker {
Jeff Gastonc21caf92018-10-16 13:24:41 -040027 method @WorkerThread public void addObserver(androidx.room.InvalidationTracker.Observer);
shepshapardd2658c62017-11-09 17:44:55 -080028 method public void refreshVersionsAsync();
Jeff Gastonc21caf92018-10-16 13:24:41 -040029 method @WorkerThread public void removeObserver(androidx.room.InvalidationTracker.Observer);
shepshapardd2658c62017-11-09 17:44:55 -080030 }
31
Jeff Gastonc21caf92018-10-16 13:24:41 -040032 public abstract static class InvalidationTracker.Observer {
Jeff Gaston6edd4a42019-04-12 20:19:05 -040033 ctor protected InvalidationTracker.Observer(String, java.lang.String!...);
34 ctor public InvalidationTracker.Observer(String![]);
35 method public abstract void onInvalidated(java.util.Set<java.lang.String!>);
shepshapardd2658c62017-11-09 17:44:55 -080036 }
37
38 public class Room {
Jeff Gastonc21caf92018-10-16 13:24:41 -040039 ctor @Deprecated public Room();
Jeff Gaston6edd4a42019-04-12 20:19:05 -040040 method public static <T extends androidx.room.RoomDatabase> androidx.room.RoomDatabase.Builder<T!> databaseBuilder(android.content.Context, Class<T!>, String);
41 method public static <T extends androidx.room.RoomDatabase> androidx.room.RoomDatabase.Builder<T!> inMemoryDatabaseBuilder(android.content.Context, Class<T!>);
Jeff Gastonc21caf92018-10-16 13:24:41 -040042 field public static final String MASTER_TABLE_NAME = "room_master_table";
shepshapardd2658c62017-11-09 17:44:55 -080043 }
44
45 public abstract class RoomDatabase {
46 ctor public RoomDatabase();
Daniel Santiago Riveraf0f9ed82019-02-11 14:35:55 -080047 method @Deprecated public void beginTransaction();
Jeff Gastonc21caf92018-10-16 13:24:41 -040048 method @WorkerThread public abstract void clearAllTables();
shepshapardd2658c62017-11-09 17:44:55 -080049 method public void close();
Jeff Gastonc21caf92018-10-16 13:24:41 -040050 method public androidx.sqlite.db.SupportSQLiteStatement! compileStatement(String);
Alan Viveretteba069d52018-03-08 18:02:39 -050051 method protected abstract androidx.room.InvalidationTracker createInvalidationTracker();
Jeff Gastonc21caf92018-10-16 13:24:41 -040052 method protected abstract androidx.sqlite.db.SupportSQLiteOpenHelper createOpenHelper(androidx.room.DatabaseConfiguration!);
Daniel Santiago Riveraf0f9ed82019-02-11 14:35:55 -080053 method @Deprecated public void endTransaction();
Alan Viveretteba069d52018-03-08 18:02:39 -050054 method public androidx.room.InvalidationTracker getInvalidationTracker();
55 method public androidx.sqlite.db.SupportSQLiteOpenHelper getOpenHelper();
Tyson Henningee3fb4b2018-05-16 15:51:37 -070056 method public java.util.concurrent.Executor getQueryExecutor();
Daniel Santiago Rivera919986a2019-03-13 16:10:41 -070057 method public java.util.concurrent.Executor getTransactionExecutor();
mzgreen7bd7c652020-09-19 06:02:23 +000058 method public <T> T? getTypeConverter(Class<T!>);
shepshapardd2658c62017-11-09 17:44:55 -080059 method public boolean inTransaction();
Jeff Gastonc21caf92018-10-16 13:24:41 -040060 method @CallSuper public void init(androidx.room.DatabaseConfiguration);
Alan Viveretteba069d52018-03-08 18:02:39 -050061 method protected void internalInitInvalidationTracker(androidx.sqlite.db.SupportSQLiteDatabase);
shepshapardd2658c62017-11-09 17:44:55 -080062 method public boolean isOpen();
Florina Muntenescubfce5012019-07-26 17:30:08 +010063 method public android.database.Cursor query(String, Object![]?);
64 method public android.database.Cursor query(androidx.sqlite.db.SupportSQLiteQuery);
65 method public android.database.Cursor query(androidx.sqlite.db.SupportSQLiteQuery, android.os.CancellationSignal?);
Jeff Gastonc21caf92018-10-16 13:24:41 -040066 method public void runInTransaction(Runnable);
Jeff Gaston6edd4a42019-04-12 20:19:05 -040067 method public <V> V! runInTransaction(java.util.concurrent.Callable<V!>);
Daniel Santiago Riveraf0f9ed82019-02-11 14:35:55 -080068 method @Deprecated public void setTransactionSuccessful();
Jeff Gastonc21caf92018-10-16 13:24:41 -040069 field @Deprecated protected volatile androidx.sqlite.db.SupportSQLiteDatabase! mDatabase;
shepshapardd2658c62017-11-09 17:44:55 -080070 }
71
Alan Viveretteba069d52018-03-08 18:02:39 -050072 public static class RoomDatabase.Builder<T extends androidx.room.RoomDatabase> {
Jeff Gaston6edd4a42019-04-12 20:19:05 -040073 method public androidx.room.RoomDatabase.Builder<T!> addCallback(androidx.room.RoomDatabase.Callback);
74 method public androidx.room.RoomDatabase.Builder<T!> addMigrations(androidx.room.migration.Migration!...);
mzgreen7bd7c652020-09-19 06:02:23 +000075 method public androidx.room.RoomDatabase.Builder<T!> addTypeConverter(Object);
Jeff Gaston6edd4a42019-04-12 20:19:05 -040076 method public androidx.room.RoomDatabase.Builder<T!> allowMainThreadQueries();
shepshapardd2658c62017-11-09 17:44:55 -080077 method public T build();
Daniel Santiago Riverae70c2aa2019-05-25 16:37:56 -070078 method public androidx.room.RoomDatabase.Builder<T!> createFromAsset(String);
Daniel Santiago Riveraf5ab17f2020-08-20 09:14:10 -070079 method public androidx.room.RoomDatabase.Builder<T!> createFromAsset(String, androidx.room.RoomDatabase.PrepackagedDatabaseCallback);
Daniel Santiago Rivera23f47e62019-06-13 15:17:22 -070080 method public androidx.room.RoomDatabase.Builder<T!> createFromFile(java.io.File);
Daniel Santiago Riveraf5ab17f2020-08-20 09:14:10 -070081 method public androidx.room.RoomDatabase.Builder<T!> createFromFile(java.io.File, androidx.room.RoomDatabase.PrepackagedDatabaseCallback);
Ahmed El-Helw3e6792c2020-08-05 00:03:57 +000082 method public androidx.room.RoomDatabase.Builder<T!> createFromInputStream(java.util.concurrent.Callable<java.io.InputStream!>);
Daniel Santiago Riveraf5ab17f2020-08-20 09:14:10 -070083 method public androidx.room.RoomDatabase.Builder<T!> createFromInputStream(java.util.concurrent.Callable<java.io.InputStream!>, androidx.room.RoomDatabase.PrepackagedDatabaseCallback);
Jeff Gaston6edd4a42019-04-12 20:19:05 -040084 method public androidx.room.RoomDatabase.Builder<T!> enableMultiInstanceInvalidation();
85 method public androidx.room.RoomDatabase.Builder<T!> fallbackToDestructiveMigration();
86 method public androidx.room.RoomDatabase.Builder<T!> fallbackToDestructiveMigrationFrom(int...);
87 method public androidx.room.RoomDatabase.Builder<T!> fallbackToDestructiveMigrationOnDowngrade();
88 method public androidx.room.RoomDatabase.Builder<T!> openHelperFactory(androidx.sqlite.db.SupportSQLiteOpenHelper.Factory?);
89 method public androidx.room.RoomDatabase.Builder<T!> setJournalMode(androidx.room.RoomDatabase.JournalMode);
90 method public androidx.room.RoomDatabase.Builder<T!> setQueryExecutor(java.util.concurrent.Executor);
91 method public androidx.room.RoomDatabase.Builder<T!> setTransactionExecutor(java.util.concurrent.Executor);
shepshapardd2658c62017-11-09 17:44:55 -080092 }
93
Jeff Gastonc21caf92018-10-16 13:24:41 -040094 public abstract static class RoomDatabase.Callback {
shepshapardd2658c62017-11-09 17:44:55 -080095 ctor public RoomDatabase.Callback();
Alan Viveretteba069d52018-03-08 18:02:39 -050096 method public void onCreate(androidx.sqlite.db.SupportSQLiteDatabase);
Florina Muntenescuc4fb72e2019-07-17 08:51:17 +010097 method public void onDestructiveMigration(androidx.sqlite.db.SupportSQLiteDatabase);
Alan Viveretteba069d52018-03-08 18:02:39 -050098 method public void onOpen(androidx.sqlite.db.SupportSQLiteDatabase);
shepshapardd2658c62017-11-09 17:44:55 -080099 }
100
Jeff Gaston5d65a6a2019-01-23 13:44:15 -0500101 public enum RoomDatabase.JournalMode {
Alan Viveretteba069d52018-03-08 18:02:39 -0500102 enum_constant public static final androidx.room.RoomDatabase.JournalMode AUTOMATIC;
103 enum_constant public static final androidx.room.RoomDatabase.JournalMode TRUNCATE;
Jeff Gastonc21caf92018-10-16 13:24:41 -0400104 enum_constant @RequiresApi(android.os.Build.VERSION_CODES.JELLY_BEAN) public static final androidx.room.RoomDatabase.JournalMode WRITE_AHEAD_LOGGING;
Yuichi Araki2eb8c312018-01-30 11:06:36 +0900105 }
106
shepshapardd2658c62017-11-09 17:44:55 -0800107 public static class RoomDatabase.MigrationContainer {
108 ctor public RoomDatabase.MigrationContainer();
Jeff Gaston6edd4a42019-04-12 20:19:05 -0400109 method public void addMigrations(androidx.room.migration.Migration!...);
110 method public java.util.List<androidx.room.migration.Migration!>? findMigrationPath(int, int);
shepshapardd2658c62017-11-09 17:44:55 -0800111 }
112
Daniel Santiago Riveraf5ab17f2020-08-20 09:14:10 -0700113 public abstract static class RoomDatabase.PrepackagedDatabaseCallback {
114 ctor public RoomDatabase.PrepackagedDatabaseCallback();
mzgreen52c2e0b2020-08-07 20:22:02 +0000115 method public void onOpenPrepackagedDatabase(androidx.sqlite.db.SupportSQLiteDatabase);
116 }
117
shepshapardd2658c62017-11-09 17:44:55 -0800118}
119
Alan Viveretteba069d52018-03-08 18:02:39 -0500120package androidx.room.migration {
shepshapardd2658c62017-11-09 17:44:55 -0800121
122 public abstract class Migration {
123 ctor public Migration(int, int);
Alan Viveretteba069d52018-03-08 18:02:39 -0500124 method public abstract void migrate(androidx.sqlite.db.SupportSQLiteDatabase);
shepshapardd2658c62017-11-09 17:44:55 -0800125 field public final int endVersion;
126 field public final int startVersion;
127 }
128
129}
130