1 /* 2 * Copyright (C) 2018 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 17 package libcore.api; 18 19 import static java.lang.annotation.ElementType.ANNOTATION_TYPE; 20 import static java.lang.annotation.ElementType.CONSTRUCTOR; 21 import static java.lang.annotation.ElementType.FIELD; 22 import static java.lang.annotation.ElementType.METHOD; 23 import static java.lang.annotation.ElementType.TYPE; 24 25 import java.lang.annotation.Retention; 26 import java.lang.annotation.RetentionPolicy; 27 import java.lang.annotation.Target; 28 29 /** 30 * Indicates that an API is hidden by default, in a similar fashion to the 31 * <pre>@hide</pre> javadoc tag. 32 * 33 * <p>Note that, in order for this to work, metalava has to be invoked with 34 * the flag {@code --hide-annotation libcore.api.Hide}. 35 * 36 * <p>This annotation should be used in {@code .annotated.java} stub files which 37 * contain API inclusion information about {@code libcore/ojluni} classes, to 38 * avoid patching the source files with <pre>@hide</pre> javadoc tags. All 39 * build targets which consume these stub files should also apply the above 40 * metalava flag. 41 * 42 * @hide 43 */ 44 @Target({TYPE, FIELD, METHOD, CONSTRUCTOR, ANNOTATION_TYPE}) 45 @Retention(RetentionPolicy.SOURCE) 46 public @interface Hide { 47 } 48