blob: 4671b1b9f8876316b2a9cd694607303ad18b519b [file] [log] [blame]
Tor Norbyecb59f2a2015-03-02 07:55:51 -08001/*
2 * Copyright (C) 2015 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 */
16package android.annotation;
17
18import java.lang.annotation.Retention;
19import java.lang.annotation.Target;
20
21import static java.lang.annotation.ElementType.FIELD;
22import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
23import static java.lang.annotation.ElementType.METHOD;
24import static java.lang.annotation.ElementType.PARAMETER;
25import static java.lang.annotation.RetentionPolicy.SOURCE;
26
27/**
28 * Denotes that the annotated element represents a packed color
Tor Norbye80756e32015-03-02 09:39:27 -080029 * int, {@code AARRGGBB}. If applied to an int array, every element
30 * in the array represents a color integer.
Tor Norbyecb59f2a2015-03-02 07:55:51 -080031 * <p>
Tor Norbye5b009412015-03-10 19:14:03 -070032 * Example:
33 * <pre>{@code
Neil Fuller71fbb812015-11-30 09:51:33 +000034 * public abstract void setTextColor(@ColorInt int color);
Tor Norbyecb59f2a2015-03-02 07:55:51 -080035 * }</pre>
36 *
37 * @hide
38 */
39@Retention(SOURCE)
40@Target({PARAMETER,METHOD,LOCAL_VARIABLE,FIELD})
41public @interface ColorInt {
42}