src/share/classes/jdk/Exported.java

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 2153
b82982ac3ca2
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package jdk;
aoqi@0 27
aoqi@0 28 import java.lang.annotation.*;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * Indicates whether or not a JDK specific type or package is an
aoqi@0 32 * exported part of the JDK suitable for use outside of the JDK
aoqi@0 33 * implementation itself.
aoqi@0 34 *
aoqi@0 35 * This annotation should only be applied to types and packages
aoqi@0 36 * <em>outside</em> of the Java SE namespaces of {@code java.*} and
aoqi@0 37 * {@code javax.*} packages. For example, certain portions of {@code
aoqi@0 38 * com.sun.*} are official parts of the JDK meant to be generally
aoqi@0 39 * usable while other portions of {@code com.sun.*} are not. This
aoqi@0 40 * annotation type allows those portions to be easily and
aoqi@0 41 * programmatically distinguished.
aoqi@0 42 *
aoqi@0 43 * <p>If in one release a type or package is
aoqi@0 44 * <code>@Exported(true)</code>, in a subsequent major release such a
aoqi@0 45 * type or package can transition to <code>@Exported(false)</code>.
aoqi@0 46 *
aoqi@0 47 * <p>If a type or package is <code>@Exported(false)</code> in a
aoqi@0 48 * release, it may be removed in a subsequent major release.
aoqi@0 49 *
aoqi@0 50 * <p>If a top-level type has an <code>@Exported</code> annotation,
aoqi@0 51 * any nested member types with the top-level type should have an
aoqi@0 52 * <code>@Exported</code> annotation with the same value.
aoqi@0 53 *
aoqi@0 54 * (In exceptional cases, if a nested type is going to be removed
aoqi@0 55 * before its enclosing type, the nested type's could be
aoqi@0 56 * <code>@Exported(false)</code> while its enclosing type was
aoqi@0 57 * <code>@Exported(true)</code>.)
aoqi@0 58 *
aoqi@0 59 * Likewise, if a package has an <code>@Exported</code> annotation,
aoqi@0 60 * top-level types within that package should also have an
aoqi@0 61 * <code>@Exported</code> annotation.
aoqi@0 62 *
aoqi@0 63 * Sometimes a top-level type may have a different
aoqi@0 64 * <code>@Exported</code> value than its package.
aoqi@0 65 *
aoqi@0 66 * @since 1.8
aoqi@0 67 */
aoqi@0 68 @Documented
aoqi@0 69 @Retention(RetentionPolicy.RUNTIME)
aoqi@0 70 @Target({ElementType.TYPE, ElementType.PACKAGE})
aoqi@0 71 @Exported
aoqi@0 72 public @interface Exported {
aoqi@0 73 /**
aoqi@0 74 * Whether or not the annotated type or package is an exported part of the JDK.
aoqi@0 75 */
aoqi@0 76 boolean value() default true;
aoqi@0 77 }

mercurial