Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/jdk/Supported.java@55cca2f38ee6 (annotated)
src/share/classes/jdk/Supported.java
Fri, 01 Feb 2013 13:01:26 -0800
- author
- darcy
- date
- Fri, 01 Feb 2013 13:01:26 -0800
- changeset 1540
- 55cca2f38ee6
- permissions
- -rw-r--r--
8001614: Include annotation type to documented supported-ness
Reviewed-by: alanb, jjg, tbell
| darcy@1540 | 1 | /* |
| darcy@1540 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
| darcy@1540 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| darcy@1540 | 4 | * |
| darcy@1540 | 5 | * This code is free software; you can redistribute it and/or modify it |
| darcy@1540 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| darcy@1540 | 7 | * published by the Free Software Foundation. Oracle designates this |
| darcy@1540 | 8 | * particular file as subject to the "Classpath" exception as provided |
| darcy@1540 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| darcy@1540 | 10 | * |
| darcy@1540 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| darcy@1540 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| darcy@1540 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| darcy@1540 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| darcy@1540 | 15 | * accompanied this code). |
| darcy@1540 | 16 | * |
| darcy@1540 | 17 | * You should have received a copy of the GNU General Public License version |
| darcy@1540 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| darcy@1540 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| darcy@1540 | 20 | * |
| darcy@1540 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| darcy@1540 | 22 | * or visit www.oracle.com if you need additional information or have any |
| darcy@1540 | 23 | * questions. |
| darcy@1540 | 24 | */ |
| darcy@1540 | 25 | |
| darcy@1540 | 26 | package jdk; |
| darcy@1540 | 27 | |
| darcy@1540 | 28 | import java.lang.annotation.*; |
| darcy@1540 | 29 | |
| darcy@1540 | 30 | /** |
| darcy@1540 | 31 | * Indicates whether or not a JDK specific type or package is a |
| darcy@1540 | 32 | * supported part of the JDK. |
| darcy@1540 | 33 | * |
| darcy@1540 | 34 | * This annotation should only be applied to types and packages |
| darcy@1540 | 35 | * <em>outside</em> of the Java SE namespaces of {@code java.*} and |
| darcy@1540 | 36 | * {@code javax.*} packages. For example, certain portions of {@code |
| darcy@1540 | 37 | * com.sun.*} are official parts of the JDK meant to be generally |
| darcy@1540 | 38 | * usable while other portions of {@code com.sun.*} are not. This |
| darcy@1540 | 39 | * annotation type allows those portions to be easily and |
| darcy@1540 | 40 | * programmaticly distinguished. |
| darcy@1540 | 41 | * |
| darcy@1540 | 42 | * @since 1.8 |
| darcy@1540 | 43 | */ |
| darcy@1540 | 44 | @Documented |
| darcy@1540 | 45 | @Retention(RetentionPolicy.RUNTIME) |
| darcy@1540 | 46 | @Target({ElementType.TYPE, ElementType.PACKAGE}) |
| darcy@1540 | 47 | @Supported |
| darcy@1540 | 48 | public @interface Supported { |
| darcy@1540 | 49 | /** |
| darcy@1540 | 50 | * Whether or not this package or type is a supported part of the JDK. |
| darcy@1540 | 51 | */ |
| darcy@1540 | 52 | boolean value() default true; |
| darcy@1540 | 53 | } |
