Preserve API compatibility for Database.DatabaseDriver

facebook · Mar 11, 2017 · e94789e · e94789e
1 parent 1506dd2
commit e94789e
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 13 deletions.
diff --git a/stetho/src/main/java/com/facebook/stetho/Stetho.java b/stetho/src/main/java/com/facebook/stetho/Stetho.java
@@ -44,7 +44,6 @@
 import com.facebook.stetho.inspector.protocol.module.DOMStorage;
 import com.facebook.stetho.inspector.protocol.module.Database;
 import com.facebook.stetho.inspector.protocol.module.DatabaseConstants;
-import com.facebook.stetho.inspector.protocol.module.DatabaseDriver;
 import com.facebook.stetho.inspector.protocol.module.DatabaseDriver2;
 import com.facebook.stetho.inspector.protocol.module.Debugger;
 import com.facebook.stetho.inspector.protocol.module.HeapProfiler;
@@ -301,7 +300,7 @@ public DefaultInspectorModulesBuilder databaseFiles(DatabaseFilesProvider provid
      * @deprecated Convert your custom database driver to {@link DatabaseDriver2}.
      */
     @Deprecated
-    public DefaultInspectorModulesBuilder provideDatabaseDriver(DatabaseDriver databaseDriver) {
+    public DefaultInspectorModulesBuilder provideDatabaseDriver(Database.DatabaseDriver databaseDriver) {
       provideDatabaseDriver(new DatabaseDriver2Adapter(databaseDriver));
       return this;
     }

diff --git a/...o/src/main/java/com/facebook/stetho/inspector/database/ContentProviderDatabaseDriver.java b/...o/src/main/java/com/facebook/stetho/inspector/database/ContentProviderDatabaseDriver.java
@@ -16,7 +16,6 @@
 
 import com.facebook.stetho.inspector.protocol.module.Database;
 import com.facebook.stetho.inspector.protocol.module.DatabaseDescriptor;
-import com.facebook.stetho.inspector.protocol.module.DatabaseDriver;
 import com.facebook.stetho.inspector.protocol.module.DatabaseDriver2;
 
 import java.util.ArrayList;

diff --git a/stetho/src/main/java/com/facebook/stetho/inspector/database/DatabaseDriver2Adapter.java b/stetho/src/main/java/com/facebook/stetho/inspector/database/DatabaseDriver2Adapter.java
@@ -4,7 +4,6 @@
 
 import com.facebook.stetho.inspector.protocol.module.Database;
 import com.facebook.stetho.inspector.protocol.module.DatabaseDescriptor;
-import com.facebook.stetho.inspector.protocol.module.DatabaseDriver;
 import com.facebook.stetho.inspector.protocol.module.DatabaseDriver2;
 
 import java.util.ArrayList;
@@ -17,9 +16,9 @@
 @Deprecated
 public class DatabaseDriver2Adapter
     extends DatabaseDriver2<DatabaseDriver2Adapter.StringDatabaseDescriptor> {
-  private final DatabaseDriver mLegacy;
+  private final Database.DatabaseDriver mLegacy;
 
-  public DatabaseDriver2Adapter(DatabaseDriver legacy) {
+  public DatabaseDriver2Adapter(Database.DatabaseDriver legacy) {
     super(legacy.getContext());
     mLegacy = legacy;
   }

diff --git a/...ector/protocol/module/DatabaseDriver.java → ...r/protocol/module/BaseDatabaseDriver.java b/...ector/protocol/module/DatabaseDriver.java → ...r/protocol/module/BaseDatabaseDriver.java
@@ -16,15 +16,14 @@
 import java.util.List;
 
 /**
- * @deprecated Use {@link DatabaseDriver2} instead which enforces generics of
- * {@link DatabaseDescriptor}.
+ * Extend {@link DatabaseDriver2} directly.  This class is provided only as a common API compatible
+ * base layer for the legacy {@link Database.DatabaseDriver}.
  */
-@Deprecated
-public abstract class DatabaseDriver<DESC> {
+public abstract class BaseDatabaseDriver<DESC> {
 
   protected Context mContext;
 
-  public DatabaseDriver(Context context) {
+  public BaseDatabaseDriver(Context context) {
     mContext = context;
   }
 

diff --git a/stetho/src/main/java/com/facebook/stetho/inspector/protocol/module/Database.java b/stetho/src/main/java/com/facebook/stetho/inspector/protocol/module/Database.java
@@ -16,6 +16,7 @@
 import java.util.List;
 
 import android.annotation.TargetApi;
+import android.content.Context;
 import android.database.Cursor;
 import android.database.sqlite.SQLiteException;
 import android.os.Build;
@@ -365,4 +366,15 @@ public static class Error {
     public int code;
   }
 
+  /**
+   * @deprecated Use {@link DatabaseDriver2} which allows for structured identifiers of database
+   *     objects (such as a file path instead of just a string name) which also serves as a
+   *     namespacing separation of multiple drivers.
+   */
+  @Deprecated
+  public static abstract class DatabaseDriver extends BaseDatabaseDriver<String> {
+    public DatabaseDriver(Context context) {
+      super(context);
+    }
+  }
 }
diff --git a/stetho/src/main/java/com/facebook/stetho/inspector/protocol/module/DatabaseDriver2.java b/stetho/src/main/java/com/facebook/stetho/inspector/protocol/module/DatabaseDriver2.java
@@ -12,11 +12,11 @@
 import android.content.Context;
 
 /**
- * Replaces {@link DatabaseDriver} to enforce that the generic type must
+ * Replaces {@link Database.DatabaseDriver} to enforce that the generic type must
  * extend {@link DatabaseDescriptor}.
  */
 public abstract class DatabaseDriver2<DESC extends DatabaseDescriptor>
-    extends DatabaseDriver<DESC> {
+    extends BaseDatabaseDriver<DESC> {
   public DatabaseDriver2(Context context) {
     super(context);
   }