• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/javax/xml/bind/annotation/XmlAttribute.java@9c07ef4934dd (annotated)

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

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 397

b99d7e355d4b

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2004, 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 javax.xml.bind.annotation;
aoqi@0	27
aoqi@0	28	import java.lang.annotation.Retention;
aoqi@0	29	import java.lang.annotation.Target;
aoqi@0	30
aoqi@0	31	import static java.lang.annotation.ElementType.*;
aoqi@0	32	import static java.lang.annotation.RetentionPolicy.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* <p>
aoqi@0	36	* Maps a JavaBean property to a XML attribute.
aoqi@0	37	*
aoqi@0	38	* <p> <b>Usage</b> </p>
aoqi@0	39	* <p>
aoqi@0	40	* The <tt>@XmlAttribute</tt> annotation can be used with the
aoqi@0	41	* following program elements:
aoqi@0	42	* <ul>
aoqi@0	43	* <li> JavaBean property </li>
aoqi@0	44	* <li> field </li>
aoqi@0	45	* </ul>
aoqi@0	46	*
aoqi@0	47	* <p> A static final field is mapped to a XML fixed attribute.
aoqi@0	48	*
aoqi@0	49	* <p>See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0	50	* additional common information.</p>
aoqi@0	51	*
aoqi@0	52	* The usage is subject to the following constraints:
aoqi@0	53	* <ul>
aoqi@0	54	* <li> If type of the field or the property is a collection
aoqi@0	55	* type, then the collection item type must be mapped to schema
aoqi@0	56	* simple type.
aoqi@0	57	* <pre>
aoqi@0	58	* // Examples
aoqi@0	59	* &#64;XmlAttribute List&lt;Integer> items; //legal
aoqi@0	60	* &#64;XmlAttribute List&lt;Bar> foo; // illegal if Bar does not map to a schema simple type
aoqi@0	61	* </pre>
aoqi@0	62	* </li>
aoqi@0	63	* <li> If the type of the field or the property is a non
aoqi@0	64	* collection type, then the type of the property or field
aoqi@0	65	* must map to a simple schema type.
aoqi@0	66	* <pre>
aoqi@0	67	* // Examples
aoqi@0	68	* &#64;XmlAttribute int foo; // legal
aoqi@0	69	* &#64;XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type
aoqi@0	70	* </pre>
aoqi@0	71	* </li>
aoqi@0	72	* <li> This annotation can be used with the following annotations:
aoqi@0	73	* {@link XmlID},
aoqi@0	74	* {@link XmlIDREF},
aoqi@0	75	* {@link XmlList},
aoqi@0	76	* {@link XmlSchemaType},
aoqi@0	77	* {@link XmlValue},
aoqi@0	78	* {@link XmlAttachmentRef},
aoqi@0	79	* {@link XmlMimeType},
aoqi@0	80	* {@link XmlInlineBinaryData},
aoqi@0	81	* {@link javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter}.</li>
aoqi@0	82	* </ul>
aoqi@0	83	* </p>
aoqi@0	84	*
aoqi@0	85	* <p> <b>Example 1: </b>Map a JavaBean property to an XML attribute.</p>
aoqi@0	86	* <pre>
aoqi@0	87	* //Example: Code fragment
aoqi@0	88	* public class USPrice {
aoqi@0	89	* &#64;XmlAttribute
aoqi@0	90	* public java.math.BigDecimal getPrice() {...} ;
aoqi@0	91	* public void setPrice(java.math.BigDecimal ) {...};
aoqi@0	92	* }
aoqi@0	93	*
aoqi@0	94	* &lt;!-- Example: XML Schema fragment -->
aoqi@0	95	* &lt;xs:complexType name="USPrice">
aoqi@0	96	* &lt;xs:sequence>
aoqi@0	97	* &lt;/xs:sequence>
aoqi@0	98	* &lt;xs:attribute name="price" type="xs:decimal"/>
aoqi@0	99	* &lt;/xs:complexType>
aoqi@0	100	* </pre>
aoqi@0	101	*
aoqi@0	102	* <p> <b>Example 2: </b>Map a JavaBean property to an XML attribute with anonymous type.</p>
aoqi@0	103	* See Example 7 in @{@link XmlType}.
aoqi@0	104	*
aoqi@0	105	* <p> <b>Example 3: </b>Map a JavaBean collection property to an XML attribute.</p>
aoqi@0	106	* <pre>
aoqi@0	107	* // Example: Code fragment
aoqi@0	108	* class Foo {
aoqi@0	109	* ...
aoqi@0	110	* &#64;XmlAttribute List&lt;Integer> items;
aoqi@0	111	* }
aoqi@0	112	*
aoqi@0	113	* &lt;!-- Example: XML Schema fragment -->
aoqi@0	114	* &lt;xs:complexType name="foo">
aoqi@0	115	* ...
aoqi@0	116	* &lt;xs:attribute name="items">
aoqi@0	117	* &lt;xs:simpleType>
aoqi@0	118	* &lt;xs:list itemType="xs:int"/>
aoqi@0	119	* &lt;/xs:simpleType>
aoqi@0	120	* &lt;/xs:complexType>
aoqi@0	121	*
aoqi@0	122	* </pre>
aoqi@0	123	* @author Sekhar Vajjhala, Sun Microsystems, Inc.
aoqi@0	124	* @see XmlType
aoqi@0	125	* @since JAXB2.0
aoqi@0	126	*/
aoqi@0	127
aoqi@0	128	@Retention(RUNTIME) @Target({FIELD, METHOD})
aoqi@0	129	public @interface XmlAttribute {
aoqi@0	130	/**
aoqi@0	131	* Name of the XML Schema attribute. By default, the XML Schema
aoqi@0	132	* attribute name is derived from the JavaBean property name.
aoqi@0	133	*
aoqi@0	134	*/
aoqi@0	135	String name() default "##default";
aoqi@0	136
aoqi@0	137	/**
aoqi@0	138	* Specifies if the XML Schema attribute is optional or
aoqi@0	139	* required. If true, then the JavaBean property is mapped to a
aoqi@0	140	* XML Schema attribute that is required. Otherwise it is mapped
aoqi@0	141	* to a XML Schema attribute that is optional.
aoqi@0	142	*
aoqi@0	143	*/
aoqi@0	144	boolean required() default false;
aoqi@0	145
aoqi@0	146	/**
aoqi@0	147	* Specifies the XML target namespace of the XML Schema
aoqi@0	148	* attribute.
aoqi@0	149	*
aoqi@0	150	*/
aoqi@0	151	String namespace() default "##default" ;
aoqi@0	152	}