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

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

src/share/jaxws_classes/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.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.adapters;
aoqi@0	27
aoqi@0	28	import javax.xml.bind.annotation.XmlAnyElement;
aoqi@0	29	import javax.xml.bind.annotation.XmlElementRefs;
aoqi@0	30	import javax.xml.bind.annotation.XmlElement;
aoqi@0	31	import javax.xml.bind.annotation.XmlSchemaType;
aoqi@0	32	import javax.xml.bind.annotation.XmlElementRef;
aoqi@0	33	import javax.xml.bind.annotation.XmlAttribute;
aoqi@0	34	import javax.xml.bind.annotation.XmlSchema;
aoqi@0	35	import javax.xml.bind.annotation.XmlAccessorType;
aoqi@0	36	import javax.xml.bind.annotation.XmlSchemaTypes;
aoqi@0	37	import java.lang.annotation.Target;
aoqi@0	38	import java.lang.annotation.Retention;
aoqi@0	39
aoqi@0	40	import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0	41	import static java.lang.annotation.ElementType.FIELD;
aoqi@0	42	import static java.lang.annotation.ElementType.METHOD;
aoqi@0	43	import static java.lang.annotation.ElementType.TYPE;
aoqi@0	44	import static java.lang.annotation.ElementType.PARAMETER;
aoqi@0	45	import static java.lang.annotation.ElementType.PACKAGE;
aoqi@0	46
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Use an adapter that implements {@link XmlAdapter} for custom marshaling.
aoqi@0	50	*
aoqi@0	51	* <p> <b> Usage: </b> </p>
aoqi@0	52	*
aoqi@0	53	* <p> The <tt>@XmlJavaTypeAdapter</tt> annotation can be used with the
aoqi@0	54	* following program elements:
aoqi@0	55	* <ul>
aoqi@0	56	* <li> a JavaBean property </li>
aoqi@0	57	* <li> field </li>
aoqi@0	58	* <li> parameter </li>
aoqi@0	59	* <li> package </li>
aoqi@0	60	* <li> from within {@link XmlJavaTypeAdapters} </li>
aoqi@0	61	* </ul>
aoqi@0	62	*
aoqi@0	63	* <p> When <tt>@XmlJavaTypeAdapter</tt> annotation is defined on a
aoqi@0	64	* class, it applies to all references to the class.
aoqi@0	65	* <p> When <tt>@XmlJavaTypeAdapter</tt> annotation is defined at the
aoqi@0	66	* package level it applies to all references from within the package
aoqi@0	67	* to <tt>@XmlJavaTypeAdapter.type()</tt>.
aoqi@0	68	* <p> When <tt>@XmlJavaTypeAdapter</tt> annotation is defined on the
aoqi@0	69	* field, property or parameter, then the annotation applies to the
aoqi@0	70	* field, property or the parameter only.
aoqi@0	71	* <p> A <tt>@XmlJavaTypeAdapter</tt> annotation on a field, property
aoqi@0	72	* or parameter overrides the <tt>@XmlJavaTypeAdapter</tt> annotation
aoqi@0	73	* associated with the class being referenced by the field, property
aoqi@0	74	* or parameter.
aoqi@0	75	* <p> A <tt>@XmlJavaTypeAdapter</tt> annotation on a class overrides
aoqi@0	76	* the <tt>@XmlJavaTypeAdapter</tt> annotation specified at the
aoqi@0	77	* package level for that class.
aoqi@0	78	*
aoqi@0	79	* <p>This annotation can be used with the following other annotations:
aoqi@0	80	* {@link XmlElement}, {@link XmlAttribute}, {@link XmlElementRef},
aoqi@0	81	* {@link XmlElementRefs}, {@link XmlAnyElement}. This can also be
aoqi@0	82	* used at the package level with the following annotations:
aoqi@0	83	* {@link XmlAccessorType}, {@link XmlSchema}, {@link XmlSchemaType},
aoqi@0	84	* {@link XmlSchemaTypes}.
aoqi@0	85	*
aoqi@0	86	* <p><b> Example: </b> See example in {@link XmlAdapter}
aoqi@0	87	*
aoqi@0	88	* @author <ul><li>Sekhar Vajjhala, Sun Microsystems Inc.</li> <li> Kohsuke Kawaguchi, Sun Microsystems Inc.</li></ul>
aoqi@0	89	* @since JAXB2.0
aoqi@0	90	* @see XmlAdapter
aoqi@0	91	*/
aoqi@0	92
aoqi@0	93	@Retention(RUNTIME) @Target({PACKAGE,FIELD,METHOD,TYPE,PARAMETER})
aoqi@0	94	public @interface XmlJavaTypeAdapter {
aoqi@0	95	/**
aoqi@0	96	* Points to the class that converts a value type to a bound type or vice versa.
aoqi@0	97	* See {@link XmlAdapter} for more details.
aoqi@0	98	*/
aoqi@0	99	Class<? extends XmlAdapter> value();
aoqi@0	100
aoqi@0	101	/**
aoqi@0	102	* If this annotation is used at the package level, then value of
aoqi@0	103	* the type() must be specified.
aoqi@0	104	*/
aoqi@0	105
aoqi@0	106	Class type() default DEFAULT.class;
aoqi@0	107
aoqi@0	108	/**
aoqi@0	109	* Used in {@link XmlJavaTypeAdapter#type()} to
aoqi@0	110	* signal that the type be inferred from the signature
aoqi@0	111	* of the field, property, parameter or the class.
aoqi@0	112	*/
aoqi@0	113
aoqi@0	114	static final class DEFAULT {}
aoqi@0	115
aoqi@0	116	}