summaryrefslogtreecommitdiff
path: root/core/java/android/annotation/FloatRange.java
diff options
context:
space:
mode:
authorTor Norbye <tnorbye@google.com>2015-03-02 07:55:51 -0800
committerTor Norbye <tnorbye@google.com>2015-03-05 16:34:11 -0800
commitcb59f2afb7a403af7c2bb6a6deb2c981a156fb96 (patch)
treeed9e32fa4957b9f9397d193e9a5016cd46cbd4a3 /core/java/android/annotation/FloatRange.java
parent9488813873735174d762615ea8a78cf60c21c10f (diff)
Additional annotations: @CallSuper, @Keep, etc.
These mirror the new support library annotations, but with source retention. Change-Id: Ib85ceeb37d596aae8cf12d4f8fede3982552d033
Diffstat (limited to 'core/java/android/annotation/FloatRange.java')
-rw-r--r--core/java/android/annotation/FloatRange.java55
1 files changed, 55 insertions, 0 deletions
diff --git a/core/java/android/annotation/FloatRange.java b/core/java/android/annotation/FloatRange.java
new file mode 100644
index 000000000000..3a7c15015b49
--- /dev/null
+++ b/core/java/android/annotation/FloatRange.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2015 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package android.annotation;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+/**
+ * Denotes that the annotated element should be a float or double in the given range
+ * <p>
+ * Example:
+ * <pre>{@code
+ * &#64;FloatRange(from=0.0,to=1.0)
+ * public float getAlpha() {
+ * ...
+ * }
+ * }</pre>
+ *
+ * @hide
+ */
+@Retention(SOURCE)
+@Target({METHOD,PARAMETER,FIELD,LOCAL_VARIABLE})
+public @interface FloatRange {
+ /** Smallest value. Whether it is inclusive or not is determined
+ * by {@link #fromInclusive} */
+ double from() default Double.NEGATIVE_INFINITY;
+ /** Largest value. Whether it is inclusive or not is determined
+ * by {@link #toInclusive} */
+ double to() default Double.POSITIVE_INFINITY;
+
+ /** Whether the from value is included in the range */
+ boolean fromInclusive() default true;
+
+ /** Whether the to value is included in the range */
+ boolean toInclusive() default true;
+} \ No newline at end of file