Home | History | Annotate | Download | only in annotation
      1 /*
      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  */
     16 package android.annotation;
     17 
     18 import java.lang.annotation.Retention;
     19 import java.lang.annotation.Target;
     20 
     21 import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
     22 import static java.lang.annotation.ElementType.FIELD;
     23 import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
     24 import static java.lang.annotation.ElementType.METHOD;
     25 import static java.lang.annotation.ElementType.PARAMETER;
     26 import static java.lang.annotation.RetentionPolicy.SOURCE;
     27 
     28 /**
     29  * Denotes that the annotated element should be an int or long in the given range
     30  * <p>
     31  * Example:
     32  * <pre><code>
     33  *  &#64;IntRange(from=0,to=255)
     34  *  public int getAlpha() {
     35  *      ...
     36  *  }
     37  * </code></pre>
     38  *
     39  * @hide
     40  */
     41 @Retention(SOURCE)
     42 @Target({METHOD,PARAMETER,FIELD,LOCAL_VARIABLE,ANNOTATION_TYPE})
     43 public @interface IntRange {
     44     /** Smallest value, inclusive */
     45     long from() default Long.MIN_VALUE;
     46     /** Largest value, inclusive */
     47     long to() default Long.MAX_VALUE;
     48 }