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 */
16package android.support.annotation;
17
18import java.lang.annotation.Retention;
19import java.lang.annotation.Target;
20
21import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
22import static java.lang.annotation.ElementType.FIELD;
23import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
24import static java.lang.annotation.ElementType.METHOD;
25import static java.lang.annotation.ElementType.PARAMETER;
26import static java.lang.annotation.RetentionPolicy.CLASS;
27
28/**
29 * Denotes that the annotated element should have a given size or length.
30 * Note that "-1" means "unset". Typically used with a parameter or
31 * return value of type array or collection.
32 * <p>
33 * Example:
34 * <pre>{@code
35 *  public void getLocationInWindow(@Size(2) int[] location) {
36 *      ...
37 *  }
38 * }</pre>
39 */
40@Retention(CLASS)
41@Target({PARAMETER,LOCAL_VARIABLE,METHOD,FIELD,ANNOTATION_TYPE})
42public @interface Size {
43    /** An exact size (or -1 if not specified) */
44    long value() default -1;
45    /** A minimum size, inclusive */
46    long min() default Long.MIN_VALUE;
47    /** A maximum size, inclusive */
48    long max() default Long.MAX_VALUE;
49    /** The size must be a multiple of this factor */
50    long multiple() default 1;
51}