Skip to content

Commit 9e2cf49

Browse files
Joe MalinAndroid (Google) Code Review
authored andcommitted
Merge "DOC CHANGE: Add Content URI ref doc" into ics-mr0
2 parents b6322a5 + 1d7d0af commit 9e2cf49

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

core/java/android/content/ContentUris.java

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,54 @@
1919
import android.net.Uri;
2020

2121
/**
22-
* Utility methods useful for working with content {@link android.net.Uri}s,
23-
* those with a "content" scheme.
24-
*/
22+
* Utility methods useful for working with {@link android.net.Uri} objects
23+
* that use the "content" (content://) scheme.
24+
*
25+
*<p>
26+
* Content URIs have the syntax
27+
*</p>
28+
*<p>
29+
* <code>content://<em>authority</em>/<em>path</em>/<em>id</em></code>
30+
*</p>
31+
*<dl>
32+
* <dt>
33+
* <code>content:</code>
34+
* </dt>
35+
* <dd>
36+
* The scheme portion of the URI. This is always set to {@link
37+
* android.content.ContentResolver#SCHEME_CONTENT ContentResolver.SCHEME_CONTENT} (value
38+
* <code>content://</code>).
39+
* </dd>
40+
* <dt>
41+
* <em>authority</em>
42+
* </dt>
43+
* <dd>
44+
* A string that identifies the entire content provider. All the content URIs for the provider
45+
* start with this string. To guarantee a unique authority, providers should consider
46+
* using an authority that is the same as the provider class' package identifier.
47+
* </dd>
48+
* <dt>
49+
* <em>path</em>
50+
* </dt>
51+
* <dd>
52+
* Zero or more segments, separated by a forward slash (<code>/</code>), that identify
53+
* some subset of the provider's data. Most providers use the path part to identify
54+
* individual tables. Individual segments in the path are often called
55+
* &quot;directories&quot; although they do not refer to file directories. The right-most
56+
* segment in a path is often called a &quot;twig&quot;
57+
* </dd>
58+
* <dt>
59+
* <em>id</em>
60+
* </dt>
61+
* <dd>
62+
* A unique numeric identifier for a single row in the subset of data identified by the
63+
* preceding path part. Most providers recognize content URIs that contain an id part
64+
* and give them special handling. A table that contains a column named <code>_ID</code>
65+
* often expects the id part to be a particular value for that column.
66+
* </dd>
67+
*</dl>
68+
*
69+
*/
2570
public class ContentUris {
2671

2772
/**

0 commit comments

Comments
 (0)