From 4caaf2aeca4a5e80516cd6922f1574e13eb615d2 Mon Sep 17 00:00:00 2001
From: Vasu Nori <vnori@google.com>
Date: Mon, 17 Jan 2011 15:35:28 -0800
Subject: [PATCH] bug:3362394 better documentation for
 DefaultDatabaseErrorHandler class

Change-Id: I85a278183eda297f72a740c9d23efa4aca58d2d3
---
 .../database/DefaultDatabaseErrorHandler.java  | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/core/java/android/database/DefaultDatabaseErrorHandler.java b/core/java/android/database/DefaultDatabaseErrorHandler.java
index 3619e487256fd..61337dde6c3a4 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 {