Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/annotation/XmlEnum.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,75 @@
     1.4 +/*
     1.5 + * Copyright (c) 2004, 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 javax.xml.bind.annotation;
    1.30 +
    1.31 +import static java.lang.annotation.ElementType.TYPE;
    1.32 +import java.lang.annotation.Retention;
    1.33 +import static java.lang.annotation.RetentionPolicy.RUNTIME;
    1.34 +import java.lang.annotation.Target;
    1.35 +
    1.36 +/**
    1.37 + * <p>
    1.38 + * Maps an enum type {@link Enum} to XML representation.
    1.39 + *
    1.40 + * <p>This annotation, together with {@link XmlEnumValue} provides a
    1.41 + * mapping of enum type to XML representation.
    1.42 + *
    1.43 + * <p> <b>Usage</b> </p>
    1.44 + * <p>
    1.45 + * The <tt>@XmlEnum</tt> annotation can be used with the
    1.46 + * following program elements:
    1.47 + * <ul>
    1.48 + *   <li>enum type</li>
    1.49 + * </ul>
    1.50 + *
    1.51 + * <p> The usage is subject to the following constraints:
    1.52 + * <ul>
    1.53 + *   <li> This annotation can be used the following other annotations:
    1.54 + *         {@link XmlType},
    1.55 + *         {@link XmlRootElement} </li>
    1.56 + * </ul>
    1.57 + * <p>See "Package Specification" in javax.xml.bind.package javadoc for
    1.58 + * additional common information </p>
    1.59 + *
    1.60 + * <p>An enum type is mapped to a schema simple type with enumeration
    1.61 + * facets. The schema type is derived from the Java type to which
    1.62 + * <tt>@XmlEnum.value()</tt>. Each enum constant <tt>@XmlEnumValue</tt>
    1.63 + * must have a valid lexical representation for the type
    1.64 + * <tt>@XmlEnum.value()</tt> .
    1.65 + *
    1.66 + * <p><b>Examples:</b> See examples in {@link XmlEnumValue}
    1.67 + *
    1.68 + * @since JAXB2.0
    1.69 + */
    1.70 +
    1.71 +@Retention(RUNTIME) @Target({TYPE})
    1.72 +public @interface XmlEnum {
    1.73 +    /**
    1.74 +     * Java type that is mapped to a XML simple type.
    1.75 +     *
    1.76 +     */
    1.77 +    Class<?> value() default String.class;
    1.78 +}