1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.provider;
18 
19 import static java.lang.annotation.ElementType.FIELD;
20 import static java.lang.annotation.RetentionPolicy.RUNTIME;
21 
22 import android.content.ContentProvider;
23 import android.content.ContentValues;
24 import android.database.Cursor;
25 
26 import java.lang.annotation.Documented;
27 import java.lang.annotation.Retention;
28 import java.lang.annotation.Target;
29 
30 /**
31  * Denotes that a field is a {@link ContentProvider} column. It can be used as a
32  * key for {@link ContentValues} when inserting or updating data, or as a
33  * projection when querying.
34  *
35  * @hide
36  */
37 @Documented
38 @Retention(RUNTIME)
39 @Target({FIELD})
40 public @interface Column {
41     /**
42      * The {@link Cursor#getType(int)} of the data stored in this column.
43      */
value()44     int value();
45 
46     /**
47      * This column is read-only and cannot be defined during insert or updates.
48      */
readOnly()49     boolean readOnly() default false;
50 }
51