Skip to content

Commit 8a8eebc

Browse files
committed
Color API comment updates.
Change-Id: I61c00089d0cd39e145126e709e46ba3441d49a2a
1 parent df1f572 commit 8a8eebc

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

core/java/android/provider/CalendarContract.java

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,8 @@ protected interface CalendarColumns {
304304
* or an empty string are reserved for indicating that the calendar does
305305
* not use an index for looking up the color. The provider will update
306306
* {@link #CALENDAR_COLOR} automatically when a valid index is written
307-
* to this column. @see Colors
307+
* to this column. The index must reference an existing row of the
308+
* {@link Colors} table. @see Colors
308309
* <P>
309310
* Type: TEXT
310311
* </P>
@@ -852,8 +853,11 @@ protected interface EventsColumns {
852853
* string are reserved for indicating that the event does not use an
853854
* index for looking up the color. The provider will update
854855
* {@link #EVENT_COLOR} automatically when a valid index is written to
855-
* this column. @see Colors
856-
* <P>Type: TEXT</P>
856+
* this column. The index must reference an existing row of the
857+
* {@link Colors} table. @see Colors
858+
* <P>
859+
* Type: TEXT
860+
* </P>
857861
* TODO UNHIDE
858862
*
859863
* @hide
@@ -2329,7 +2333,7 @@ protected interface ColorsColumns extends SyncStateContract.Columns {
23292333
/**
23302334
* The index used to reference this color. This can be any non-empty
23312335
* string, but must be unique for a given {@link #ACCOUNT_TYPE} and
2332-
* {@link #ACCOUNT_NAME} . Column name.
2336+
* {@link #ACCOUNT_NAME}. Column name.
23332337
* <P>
23342338
* Type: TEXT
23352339
* </P>
@@ -2354,7 +2358,9 @@ protected interface ColorsColumns extends SyncStateContract.Columns {
23542358
* Fields for accessing colors available for a given account. Colors are
23552359
* referenced by {@link #COLOR_INDEX} which must be unique for a given
23562360
* account name/type. These values should only be updated by the sync
2357-
* adapter.
2361+
* adapter. Only {@link #COLOR} may be updated after the initial insert. In
2362+
* addition, a row can only be deleted once all references to that color
2363+
* have been removed from the {@link Calendars} or {@link Events} tables.
23582364
* TODO UNHIDE
23592365
*
23602366
* @hide

0 commit comments

Comments
 (0)