src/share/jaxws_classes/javax/xml/bind/annotation/XmlSchemaType.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind.annotation;
ohair@286 27
ohair@286 28 import java.lang.annotation.Retention;
ohair@286 29 import java.lang.annotation.Target;
ohair@286 30
ohair@286 31 import static java.lang.annotation.ElementType.FIELD;
ohair@286 32 import static java.lang.annotation.ElementType.METHOD;
ohair@286 33 import static java.lang.annotation.ElementType.PACKAGE;
ohair@286 34 import static java.lang.annotation.RetentionPolicy.RUNTIME;
ohair@286 35
ohair@286 36 /**
ohair@286 37 * Maps a Java type to a simple schema built-in type.
ohair@286 38 *
ohair@286 39 * <p> <b>Usage</b> </p>
ohair@286 40 * <p>
ohair@286 41 * <tt>@XmlSchemaType</tt> annotation can be used with the following program
ohair@286 42 * elements:
ohair@286 43 * <ul>
ohair@286 44 * <li> a JavaBean property </li>
ohair@286 45 * <li> field </li>
ohair@286 46 * <li> package</li>
ohair@286 47 * </ul>
ohair@286 48 *
ohair@286 49 * <p> <tt>@XmlSchemaType</tt> annotation defined for Java type
ohair@286 50 * applies to all references to the Java type from a property/field.
ohair@286 51 * A <tt>@XmlSchemaType</tt> annotation specified on the
ohair@286 52 * property/field overrides the <tt>@XmlSchemaType</tt> annotation
ohair@286 53 * specified at the package level.
ohair@286 54 *
ohair@286 55 * <p> This annotation can be used with the following annotations:
ohair@286 56 * {@link XmlElement}, {@link XmlAttribute}.
ohair@286 57 * <p>
ohair@286 58 * <b>Example 1: </b> Customize mapping of XMLGregorianCalendar on the
ohair@286 59 * field.
ohair@286 60 *
ohair@286 61 * <pre>
ohair@286 62 * //Example: Code fragment
ohair@286 63 * public class USPrice {
ohair@286 64 * &#64;XmlElement
ohair@286 65 * &#64;XmlSchemaType(name="date")
ohair@286 66 * public XMLGregorianCalendar date;
ohair@286 67 * }
ohair@286 68 *
ohair@286 69 * &lt;!-- Example: Local XML Schema element -->
ohair@286 70 * &lt;xs:complexType name="USPrice"/>
ohair@286 71 * &lt;xs:sequence>
ohair@286 72 * &lt;xs:element name="date" type="xs:date"/>
ohair@286 73 * &lt;/sequence>
ohair@286 74 * &lt;/xs:complexType>
ohair@286 75 * </pre>
ohair@286 76 *
ohair@286 77 * <p> <b> Example 2: </b> Customize mapping of XMLGregorianCalendar at package
ohair@286 78 * level </p>
ohair@286 79 * <pre>
ohair@286 80 * package foo;
ohair@286 81 * &#64;javax.xml.bind.annotation.XmlSchemaType(
ohair@286 82 * name="date", type=javax.xml.datatype.XMLGregorianCalendar.class)
ohair@286 83 * }
ohair@286 84 * </pre>
ohair@286 85 *
ohair@286 86 * @since JAXB2.0
ohair@286 87 */
ohair@286 88
ohair@286 89 @Retention(RUNTIME) @Target({FIELD,METHOD,PACKAGE})
ohair@286 90 public @interface XmlSchemaType {
ohair@286 91 String name();
ohair@286 92 String namespace() default "http://www.w3.org/2001/XMLSchema";
ohair@286 93 /**
ohair@286 94 * If this annotation is used at the package level, then value of
ohair@286 95 * the type() must be specified.
ohair@286 96 */
ohair@286 97
ohair@286 98 Class type() default DEFAULT.class;
ohair@286 99
ohair@286 100 /**
ohair@286 101 * Used in {@link XmlSchemaType#type()} to
ohair@286 102 * signal that the type be inferred from the signature
ohair@286 103 * of the property.
ohair@286 104 */
ohair@286 105
ohair@286 106 static final class DEFAULT {}
ohair@286 107
ohair@286 108 }

mercurial