src/share/classes/jdk/Exported.java

changeset 0
959103a6100f
child 2525
2eb010b6cb22
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/jdk/Exported.java	Wed Apr 27 01:34:52 2016 +0800
     1.3 @@ -0,0 +1,77 @@
     1.4 +/*
     1.5 + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package jdk;
    1.30 +
    1.31 +import java.lang.annotation.*;
    1.32 +
    1.33 +/**
    1.34 +  * Indicates whether or not a JDK specific type or package is an
    1.35 +  * exported part of the JDK suitable for use outside of the JDK
    1.36 +  * implementation itself.
    1.37 +  *
    1.38 +  * This annotation should only be applied to types and packages
    1.39 +  * <em>outside</em> of the Java SE namespaces of {@code java.*} and
    1.40 +  * {@code javax.*} packages.  For example, certain portions of {@code
    1.41 +  * com.sun.*} are official parts of the JDK meant to be generally
    1.42 +  * usable while other portions of {@code com.sun.*} are not.  This
    1.43 +  * annotation type allows those portions to be easily and
    1.44 +  * programmatically distinguished.
    1.45 +  *
    1.46 +  * <p>If in one release a type or package is
    1.47 +  * <code>@Exported(true)</code>, in a subsequent major release such a
    1.48 +  * type or package can transition to <code>@Exported(false)</code>.
    1.49 +  *
    1.50 +  * <p>If a type or package is <code>@Exported(false)</code> in a
    1.51 +  * release, it may be removed in a subsequent major release.
    1.52 +  *
    1.53 +  * <p>If a top-level type has an <code>@Exported</code> annotation,
    1.54 +  * any nested member types with the top-level type should have an
    1.55 +  * <code>@Exported</code> annotation with the same value.
    1.56 +  *
    1.57 +  * (In exceptional cases, if a nested type is going to be removed
    1.58 +  * before its enclosing type, the nested type's could be
    1.59 +  * <code>@Exported(false)</code> while its enclosing type was
    1.60 +  * <code>@Exported(true)</code>.)
    1.61 +  *
    1.62 +  * Likewise, if a package has an <code>@Exported</code> annotation,
    1.63 +  * top-level types within that package should also have an
    1.64 +  * <code>@Exported</code> annotation.
    1.65 +  *
    1.66 +  * Sometimes a top-level type may have a different
    1.67 +  * <code>@Exported</code> value than its package.
    1.68 +  *
    1.69 +  * @since 1.8
    1.70 +  */
    1.71 +@Documented
    1.72 +@Retention(RetentionPolicy.RUNTIME)
    1.73 +@Target({ElementType.TYPE, ElementType.PACKAGE})
    1.74 +@Exported
    1.75 +public @interface Exported {
    1.76 +    /**
    1.77 +     * Whether or not the annotated type or package is an exported part of the JDK.
    1.78 +     */
    1.79 +    boolean value() default true;
    1.80 +}

mercurial