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