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