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

mercurial