summaryrefslogtreecommitdiff
path: root/core/java/android
diff options
context:
space:
mode:
authorVasu Nori <vnori@google.com>2011-01-17 15:35:28 -0800
committerVasu Nori <vnori@google.com>2011-01-17 15:35:28 -0800
commit4caaf2aeca4a5e80516cd6922f1574e13eb615d2 (patch)
tree92225c7a8633117550cb85e9fc8268a40e8c976c /core/java/android
parent0abbf809bf46eea21f64fb62c55852783269aca2 (diff)
bug:3362394 better documentation for DefaultDatabaseErrorHandler class
Change-Id: I85a278183eda297f72a740c9d23efa4aca58d2d3
Diffstat (limited to 'core/java/android')
-rw-r--r--core/java/android/database/DefaultDatabaseErrorHandler.java18
1 files changed, 16 insertions, 2 deletions
diff --git a/core/java/android/database/DefaultDatabaseErrorHandler.java b/core/java/android/database/DefaultDatabaseErrorHandler.java
index 3619e487256f..61337dde6c3a 100644
--- a/core/java/android/database/DefaultDatabaseErrorHandler.java
+++ b/core/java/android/database/DefaultDatabaseErrorHandler.java
@@ -24,8 +24,22 @@ import android.util.Log;
import android.util.Pair;
/**
- * Default class used defining the actions to take when the following errors are detected
- * database corruption
+ * Default class used to define the actions to take when the database corruption is reported
+ * by sqlite.
+ * <p>
+ * An application can specify an implementation of {@link DatabaseErrorHandler} on the
+ * following:
+ * <ul>
+ * <li>{@link SQLiteDatabase#openOrCreateDatabase(String,
+ * android.database.sqlite.SQLiteDatabase.CursorFactory, DatabaseErrorHandler)}</li>
+ * <li>{@link SQLiteDatabase#openDatabase(String,
+ * android.database.sqlite.SQLiteDatabase.CursorFactory, int, DatabaseErrorHandler)}</li>
+ * </ul>
+ * The specified {@link DatabaseErrorHandler} is used to handle database corruption errors, if they
+ * occur.
+ * <p>
+ * If null is specified for DatabaeErrorHandler param in the above calls, then this class is used
+ * as the default {@link DatabaseErrorHandler}.
*/
public final class DefaultDatabaseErrorHandler implements DatabaseErrorHandler {