/* * Copyright (C) 2016 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.support.annotation; import java.lang.annotation.Retention; import java.lang.annotation.Target; import static java.lang.annotation.ElementType.ANNOTATION_TYPE; import static java.lang.annotation.ElementType.CONSTRUCTOR; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.ElementType.PACKAGE; import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.CLASS; /** * Denotes that the annotated element should only be accessed from within a * specific scope (as defined by {@link Scope}). *
* Example of restricting usage within a library (based on gradle group ID): *
* @RestrictTo(GROUP_ID)
* public void resetPaddingToInitialValues() { ...
*
* Example of restricting usage to tests:
*
* @RestrictScope(TESTS)
* public abstract int getUserId();
*
* Example of restricting usage to subclasses:
*
* @RestrictScope(SUBCLASSES)
* public void onDrawForeground(Canvas canvas) { ...
*
*/
@Retention(CLASS)
@Target({ANNOTATION_TYPE,TYPE,METHOD,CONSTRUCTOR,FIELD,PACKAGE})
public @interface RestrictTo {
/**
* The scope to which usage should be restricted.
*/
Scope[] value();
enum Scope {
/**
* Restrict usage to code within the same group ID (based on gradle
* group ID).
*/
GROUP_ID,
/**
* Restrict usage to tests.
*/
TESTS,
/**
* Restrict usage to subclasses of the enclosing class.
* * Note: This scope should not be used to annotate * packages. */ SUBCLASSES, } }