Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update docs for SQLiteDatabase replace methods

Browse Source 
- Mention that if the row does not exist, the method performs insert
- Add parameter info for initialValues. It was incomplete

Bug: 2321632
This commit is contained in:
Mark Lu
2016-08-30 17:41:25 -07:00
parent 689c92db9d
commit 1e20208d90
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/java/android/database/sqlite/SQLiteDatabase.java
View File

@@ -1371,6 +1371,7 @@ public final class SQLiteDatabase extends SQLiteClosable {
/** /**
* Convenience method for replacing a row in the database. * Convenience method for replacing a row in the database.
* Inserts a new row if a row does not already exist.
* *
* @param table the table in which to replace the row * @param table the table in which to replace the row
* @param nullColumnHack optional; may be <code>null</code>. * @param nullColumnHack optional; may be <code>null</code>.
@@ -1381,7 +1382,7 @@ public final class SQLiteDatabase extends SQLiteClosable {
* provides the name of nullable column name to explicitly insert a NULL into * provides the name of nullable column name to explicitly insert a NULL into
* in the case where your <code>initialValues</code> is empty. * in the case where your <code>initialValues</code> is empty.
* @param initialValues this map contains the initial column values for * @param initialValues this map contains the initial column values for
* the row. * the row. The keys should be the column names and the values the column values.
* @return the row ID of the newly inserted row, or -1 if an error occurred * @return the row ID of the newly inserted row, or -1 if an error occurred
*/ */
public long replace(String table, String nullColumnHack, ContentValues initialValues) { public long replace(String table, String nullColumnHack, ContentValues initialValues) {
@@ -1396,6 +1397,7 @@ public final class SQLiteDatabase extends SQLiteClosable {
/** /**
* Convenience method for replacing a row in the database. * Convenience method for replacing a row in the database.
* Inserts a new row if a row does not already exist.
* *
* @param table the table in which to replace the row * @param table the table in which to replace the row
* @param nullColumnHack optional; may be <code>null</code>. * @param nullColumnHack optional; may be <code>null</code>.
@@ -1406,7 +1408,7 @@ public final class SQLiteDatabase extends SQLiteClosable {
* provides the name of nullable column name to explicitly insert a NULL into * provides the name of nullable column name to explicitly insert a NULL into
* in the case where your <code>initialValues</code> is empty. * in the case where your <code>initialValues</code> is empty.
* @param initialValues this map contains the initial column values for * @param initialValues this map contains the initial column values for
* the row. The key * the row. The keys should be the column names and the values the column values.
* @throws SQLException * @throws SQLException
* @return the row ID of the newly inserted row, or -1 if an error occurred * @return the row ID of the newly inserted row, or -1 if an error occurred
*/ */
@@ -1740,7 +1742,7 @@ public final class SQLiteDatabase extends SQLiteClosable {
* Returns true if the new version code is greater than the current database version. * Returns true if the new version code is greater than the current database version.
* *
* @param newVersion The new version code. * @param newVersion The new version code.
* @return True if the new version code is greater than the current database version. * @return True if the new version code is greater than the current database version.
*/ */
public boolean needUpgrade(int newVersion) { public boolean needUpgrade(int newVersion) {
return newVersion > getVersion(); return newVersion > getVersion();