Merge "Add the contract class for the new Broswer provider." (f6105cfd) · Commits · e / os / android_frameworks_base

core/java/android/provider/BrowserContract.java

0 → 100644

+365 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2010 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License
		*/

		package android.provider;

		import android.accounts.Account;
		import android.content.ContentProviderClient;
		import android.content.ContentProviderOperation;
		import android.content.ContentResolver;
		import android.content.ContentUris;
		import android.graphics.BitmapFactory;
		import android.net.Uri;
		import android.os.RemoteException;
		import android.provider.SyncStateContract;
		import android.util.Pair;

		/**
		* @hide
		*/
		public class BrowserContract {
		/** The authority for the browser provider */
		public static final String AUTHORITY = "com.android.browser";

		/** A content:// style uri to the authority for the browser provider */
		public static final Uri AUTHORITY_URI = Uri.parse("content://" + AUTHORITY);

		/**
		* An optional insert, update or delete URI parameter that allows the caller
		* to specify that it is a sync adapter. The default value is false. If true
		* the dirty flag is not automatically set and the "syncToNetwork" parameter
		* is set to false when calling
		* {@link ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver, boolean)}.
		*/
		public static final String CALLER_IS_SYNCADAPTER = "caller_is_syncadapter";

		/**
		* Generic columns for use by sync adapters. The specific functions of
		* these columns are private to the sync adapter. Other clients of the API
		* should not attempt to either read or write these columns.
		*/
		interface BaseSyncColumns {
		/** Generic column for use by sync adapters. */
		public static final String SYNC1 = "sync1";
		/** Generic column for use by sync adapters. */
		public static final String SYNC2 = "sync2";
		/** Generic column for use by sync adapters. */
		public static final String SYNC3 = "sync3";
		/** Generic column for use by sync adapters. */
		public static final String SYNC4 = "sync4";
		/** Generic column for use by sync adapters. */
		public static final String SYNC5 = "sync5";
		}

		/**
		* Columns that appear when each row of a table belongs to a specific
		* account, including sync information that an account may need.
		*/
		interface SyncColumns extends BaseSyncColumns {
		/**
		* The name of the account instance to which this row belongs, which when paired with
		* {@link #ACCOUNT_TYPE} identifies a specific account.
		* <P>Type: TEXT</P>
		*/
		public static final String ACCOUNT_NAME = "account_name";

		/**
		* The type of account to which this row belongs, which when paired with
		* {@link #ACCOUNT_NAME} identifies a specific account.
		* <P>Type: TEXT</P>
		*/
		public static final String ACCOUNT_TYPE = "account_type";

		/**
		* String that uniquely identifies this row to its source account.
		* <P>Type: TEXT</P>
		*/
		public static final String SOURCE_ID = "sourceid";

		/**
		* Version number that is updated whenever this row or its related data
		* changes.
		* <P>Type: INTEGER</P>
		*/
		public static final String VERSION = "version";

		/**
		* Flag indicating that {@link #VERSION} has changed, and this row needs
		* to be synchronized by its owning account.
		* <P>Type: INTEGER (boolean)</P>
		*/
		public static final String DIRTY = "dirty";
		}

		interface BookmarkColumns {
		/**
		* The unique ID for a row.
		* <P>Type: INTEGER (long)</P>
		*/
		public static final String _ID = "_id";

		/**
		* The URL of the bookmark.
		* <P>Type: TEXT (URL)</P>
		*/
		public static final String URL = "url";

		/**
		* The user visible title of the bookmark.
		* <P>Type: TEXT</P>
		*/
		public static final String TITLE = "title";

		/**
		* The favicon of the bookmark, may be NULL.
		* Must decode via {@link BitmapFactory#decodeByteArray}.
		* <p>Type: BLOB (image)</p>
		*/
		public static final String FAVICON = "favicon";

		/**
		* A thumbnail of the page,may be NULL.
		* Must decode via {@link BitmapFactory#decodeByteArray}.
		* <p>Type: BLOB (image)</p>
		*/
		public static final String THUMBNAIL = "thumbnail";

		/**
		* The touch icon for the web page, may be NULL.
		* Must decode via {@link BitmapFactory#decodeByteArray}.
		* <p>Type: BLOB (image)</p>
		* @hide
		*/
		public static final String TOUCH_ICON = "touch_icon";
		}

		/**
		* The bookmarks table, which holds the user's browser bookmarks.
		*/
		public static final class Bookmarks implements BookmarkColumns, SyncColumns {
		/**
		* This utility class cannot be instantiated.
		*/
		private Bookmarks() {}

		/**
		* The content:// style URI for this table
		*/
		public static final Uri CONTENT_URI = Uri.withAppendedPath(AUTHORITY_URI, "bookmarks");

		/**
		* The content:// style URI for the default folder
		*/
		public static final Uri CONTENT_URI_DEFAULT_FOLDER =
		Uri.withAppendedPath(CONTENT_URI, "folder");

		/**
		* Builds a URI that points to a specific folder.
		* @param folderId the ID of the folder to point to
		*/
		public static final Uri buildFolderUri(long folderId) {
		return ContentUris.withAppendedId(CONTENT_URI_DEFAULT_FOLDER, folderId);
		}

		/**
		* The MIME type of {@link #CONTENT_URI} providing a directory of bookmarks.
		*/
		public static final String CONTENT_TYPE = "vnd.android.cursor.dir/bookmark";

		/**
		* The MIME type of a {@link #CONTENT_URI} of a single bookmark.
		*/
		public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/bookmark";

		/**
		* Query parameter to use if you want to see deleted bookmarks that are still
		* around on the device and haven't been synced yet.
		* @see #IS_DELETED
		*/
		public static final String QUERY_PARAMETER_SHOW_DELETED = "show_deleted";

		/**
		* Flag indicating if an item is a folder or bookmark. Non-zero values indicate
		* a folder and zero indicates a bookmark.
		* <P>Type: INTEGER (boolean)</P>
		*/
		public static final String IS_FOLDER = "folder";

		/**
		* The ID of the parent folder. ID 0 is the root folder.
		* <P>Type: INTEGER (reference to item in the same table)</P>
		*/
		public static final String PARENT = "parent";

		/**
		* The position of the bookmark in relation to it's siblings that share the same
		* {@link #PARENT}. May be negative.
		* <P>Type: INTEGER</P>
		*/
		public static final String POSITION = "position";

		/**
		* The item that the bookmark should be inserted after.
		* May be negative.
		* <P>Type: INTEGER</P>
		*/
		public static final String INSERT_AFTER = "insert_after";

		/**
		* A flag to indicate if an item has been deleted. Queries will not return deleted
		* entries unless you add the {@link #QUERY_PARAMETER_SHOW_DELETED} query paramter
		* to the URI when performing your query.
		* <p>Type: INTEGER (non-zero if the item has been deleted, zero if it hasn't)
		* @see #QUERY_PARAMETER_SHOW_DELETED
		*/
		public static final String IS_DELETED = "deleted";
		}

		/**
		* The history table, which holds the browsing history.
		*/
		public static final class History implements BookmarkColumns {
		/**
		* This utility class cannot be instantiated.
		*/
		private History() {}

		/**
		* The content:// style URI for this table
		*/
		public static final Uri CONTENT_URI = Uri.withAppendedPath(AUTHORITY_URI, "history");

		/**
		* The MIME type of {@link #CONTENT_URI} providing a directory of browser history items.
		*/
		public static final String CONTENT_TYPE = "vnd.android.cursor.dir/browser-history";

		/**
		* The MIME type of a {@link #CONTENT_URI} of a single browser history item.
		*/
		public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/browser-history";

		/**
		* The date the item was last visited, in milliseconds since the epoch.
		* <p>Type: INTEGER (date in milliseconds since January 1, 1970)</p>
		*/
		public static final String DATE_LAST_VISITED = "date";

		/**
		* The date the item created, in milliseconds since the epoch.
		* <p>Type: NUMBER (date in milliseconds since January 1, 1970)</p>
		*/
		public static final String DATE_CREATED = "created";

		/**
		* The number of times the item has been visited.
		* <p>Type: INTEGER</p>
		*/
		public static final String VISITS = "visits";
		}

		/**
		* The search history table.
		* @hide
		*/
		public static final class Searches {
		private Searches() {}

		/**
		* The content:// style URI for this table
		*/
		public static final Uri CONTENT_URI = Uri.withAppendedPath(AUTHORITY_URI, "searches");

		/**
		* The MIME type of {@link #CONTENT_URI} providing a directory of browser search items.
		*/
		public static final String CONTENT_TYPE = "vnd.android.cursor.dir/searches";

		/**
		* The MIME type of a {@link #CONTENT_URI} of a single browser search item.
		*/
		public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/searches";

		/**
		* The unique ID for a row.
		* <P>Type: INTEGER (long)</P>
		*/
		public static final String _ID = "_id";

		/**
		* The user entered search term.
		*/
		public static final String SEARCH = "search";

		/**
		* The date the search was performed, in milliseconds since the epoch.
		* <p>Type: NUMBER (date in milliseconds since January 1, 1970)</p>
		*/
		public static final String DATE = "date";
		}

		/**
		* A table provided for sync adapters to use for storing private sync state data.
		*
		* @see SyncStateContract
		*/
		public static final class SyncState implements SyncStateContract.Columns {
		/**
		* This utility class cannot be instantiated
		*/
		private SyncState() {}

		public static final String CONTENT_DIRECTORY =
		SyncStateContract.Constants.CONTENT_DIRECTORY;

		/**
		* The content:// style URI for this table
		*/
		public static final Uri CONTENT_URI =
		Uri.withAppendedPath(AUTHORITY_URI, CONTENT_DIRECTORY);

		/**
		* @see android.provider.SyncStateContract.Helpers#get
		*/
		public static byte[] get(ContentProviderClient provider, Account account)
		throws RemoteException {
		return SyncStateContract.Helpers.get(provider, CONTENT_URI, account);
		}

		/**
		* @see android.provider.SyncStateContract.Helpers#get
		*/
		public static Pair<Uri, byte[]> getWithUri(ContentProviderClient provider, Account account)
		throws RemoteException {
		return SyncStateContract.Helpers.getWithUri(provider, CONTENT_URI, account);
		}

		/**
		* @see android.provider.SyncStateContract.Helpers#set
		*/
		public static void set(ContentProviderClient provider, Account account, byte[] data)
		throws RemoteException {
		SyncStateContract.Helpers.set(provider, CONTENT_URI, account, data);
		}

		/**
		* @see android.provider.SyncStateContract.Helpers#newSetOperation
		*/
		public static ContentProviderOperation newSetOperation(Account account, byte[] data) {
		return SyncStateContract.Helpers.newSetOperation(CONTENT_URI, account, data);
		}
		}
		}