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

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

src/share/jaxws_classes/javax/xml/bind/annotation/XmlSeeAlso.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) 2006, 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 javax.xml.bind.JAXBContext;
aoqi@0	29	import java.lang.annotation.ElementType;
aoqi@0	30	import java.lang.annotation.Retention;
aoqi@0	31	import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0	32	import java.lang.annotation.Target;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Instructs JAXB to also bind other classes when binding this class.
aoqi@0	36	*
aoqi@0	37	* <p>
aoqi@0	38	* Java makes it impractical/impossible to list all sub-classes of
aoqi@0	39	* a given class. This often gets in a way of JAXB users, as it JAXB
aoqi@0	40	* cannot automatically list up the classes that need to be known
aoqi@0	41	* to {@link JAXBContext}.
aoqi@0	42	*
aoqi@0	43	* <p>
aoqi@0	44	* For example, with the following class definitions:
aoqi@0	45	*
aoqi@0	46	* <pre>
aoqi@0	47	* class Animal {}
aoqi@0	48	* class Dog extends Animal {}
aoqi@0	49	* class Cat extends Animal {}
aoqi@0	50	* </pre>
aoqi@0	51	*
aoqi@0	52	* <p>
aoqi@0	53	* The user would be required to create {@link JAXBContext} as
aoqi@0	54	* <tt>JAXBContext.newInstance(Dog.class,Cat.class)</tt>
aoqi@0	55	* (<tt>Animal</tt> will be automatically picked up since <tt>Dog</tt>
aoqi@0	56	* and <tt>Cat</tt> refers to it.)
aoqi@0	57	*
aoqi@0	58	* <p>
aoqi@0	59	* {@link XmlSeeAlso} annotation would allow you to write:
aoqi@0	60	* <pre>
aoqi@0	61	* &#64;XmlSeeAlso({Dog.class,Cat.class})
aoqi@0	62	* class Animal {}
aoqi@0	63	* class Dog extends Animal {}
aoqi@0	64	* class Cat extends Animal {}
aoqi@0	65	* </pre>
aoqi@0	66	*
aoqi@0	67	* <p>
aoqi@0	68	* This would allow you to do <tt>JAXBContext.newInstance(Animal.class)</tt>.
aoqi@0	69	* By the help of this annotation, JAXB implementations will be able to
aoqi@0	70	* correctly bind <tt>Dog</tt> and <tt>Cat</tt>.
aoqi@0	71	*
aoqi@0	72	* @author Kohsuke Kawaguchi
aoqi@0	73	* @since JAXB2.1
aoqi@0	74	*/
aoqi@0	75	@Target({ElementType.TYPE})
aoqi@0	76	@Retention(RUNTIME)
aoqi@0	77	public @interface XmlSeeAlso {
aoqi@0	78	Class[] value();
aoqi@0	79	}