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.FIELD;
     22 import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
     23 import static java.lang.annotation.ElementType.METHOD;
     24 import static java.lang.annotation.ElementType.PARAMETER;
     25 import static java.lang.annotation.RetentionPolicy.SOURCE;
     26 
     27 /**
     28  * Denotes that the annotated element should be a float or double in the given range
     29  * <p>
     30  * Example:
     31  * <pre><code>
     32  *  &#64;FloatRange(from=0.0,to=1.0)
     33  *  public float getAlpha() {
     34  *      ...
     35  *  }
     36  * </code></pre>
     37  *
     38  * @hide
     39  */
     40 @Retention(SOURCE)
     41 @Target({METHOD,PARAMETER,FIELD,LOCAL_VARIABLE})
     42 public @interface FloatRange {
     43     /** Smallest value. Whether it is inclusive or not is determined
     44      * by {@link #fromInclusive} */
     45     double from() default Double.NEGATIVE_INFINITY;
     46     /** Largest value. Whether it is inclusive or not is determined
     47      * by {@link #toInclusive} */
     48     double to() default Double.POSITIVE_INFINITY;
     49 
     50     /** Whether the from value is included in the range */
     51     boolean fromInclusive() default true;
     52 
     53     /** Whether the to value is included in the range */
     54     boolean toInclusive() default true;
     55 }