1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
/* * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.bind.annotation; import java.lang.annotation.Retention; import java.lang.annotation.Target; import static java.lang.annotation.ElementType.*; import static java.lang.annotation.RetentionPolicy.*; /** * <p> Maps a package name to a XML namespace. </p> * * <p><b>Usage</b> </p> * <p> * The XmlSchema annotation can be used with the following program * elements: * <ul> * <li>package</li> * </ul> * * This is a package level annotation and follows the recommendations * and restrictions contained in JSR 175, section III, "Annotations". * Thus the usage is subject to the following constraints and * recommendations. * <ul> * <li> There can only be one package declaration as noted in JSR * 175, section III, "Annotations". </li> * <li> JSR 175 recommends package-info.java for package level * annotations. JAXB Providers that follow this recommendation * will allow the package level annotations to be defined in * package-info.java. * </ul> * <p> * * <p><b>Example 1:</b> Customize name of XML namespace to which * package is mapped.</p> * * <pre> * @javax.xml.bind.annotation.XmlSchema ( * namespace = "http://www.example.com/MYPO1" * ) * * <!-- XML Schema fragment --> * <schema * xmlns=... * xmlns:po=.... * targetNamespace="http://www.example.com/MYPO1" * > * <!-- prefixes generated by default are implementation * depedenent --> * </pre> * * <p><b>Example 2:</b> Customize namespace prefix, namespace URI * mapping</p> * * <pre> * // Package level annotation * @javax.xml.bind.annotation.XmlSchema ( * xmlns = { * @javax.xml.bind.annotation.XmlNs(prefix = "po", * namespaceURI="http://www.example.com/myPO1"), * * @javax.xml.bind.annotation.XmlNs(prefix="xs", * namespaceURI="http://www.w3.org/2001/XMLSchema") * ) * ) * * <!-- XML Schema fragment --> * <schema * xmlns:xs="http://www.w3.org/2001/XMLSchema" * xmlns:po="http://www.example.com/PO1" * targetNamespace="http://www.example.com/PO1"> * * </pre> * * <p><b>Example 3:</b> Customize elementFormDefault</p> * <pre> * @javax.xml.bind.annotation.XmlSchema ( * elementFormDefault=XmlNsForm.UNQUALIFIED * ... * ) * * <!-- XML Schema fragment --> * <schema * xmlns="http://www.w3.org/2001/XMLSchema" * xmlns:po="http://www.example.com/PO1" * elementFormDefault="unqualified"> * * </pre> * @author Sekhar Vajjhala, Sun Microsystems, Inc. * @since JAXB2.0 * @version $Revision: 1.8 $ */ @Retention(RUNTIME) @Target({PACKAGE}) public @interface XmlSchema { /** * Customize the namespace URI, prefix associations. By default, * the namespace prefixes for a XML namespace are generated by a * JAXB Provider in an implementation dependent way. */ XmlNs[] xmlns() default {}; /** * Name of the XML namespace. */ String namespace() default ""; /** * Namespace qualification for elements. By default, element * default attribute will be absent from the XML Schema fragment. */ XmlNsForm elementFormDefault() default XmlNsForm.UNSET; /** * Namespace qualification for attributes. By default, * attributesFormDefault will be absent from the XML Schema fragment. */ XmlNsForm attributeFormDefault() default XmlNsForm.UNSET; }