Top Description Fields Methods
jakarta.xml.bind.annotation

public @Interface XmlSchema

extends Annotation
Annotations
@Retention:RUNTIME
@Target:PACKAGE
Imports
java.lang.annotation.Retention, .Target

Maps a package name to a XML namespace.

Usage

The XmlSchema annotation can be used with the following program elements:

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.

Example 1: Customize name of XML namespace to which package is mapped.

   @jakarta.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 -->

Example 2: Customize namespace prefix, namespace URI mapping

   // Package level annotation
   @jakarta.xml.bind.annotation.XmlSchema (
     xmlns = {
       @jakarta.xml.bind.annotation.XmlNs(prefix = "po",
                  namespaceURI="http://www.example.com/myPO1"),

       @jakarta.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">

Example 3: Customize elementFormDefault

   @jakarta.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">
Author
Sekhar Vajjhala, Sun Microsystems, Inc.
Since
1.6, JAXB 2.0

Field Summary

Modifier and TypeField and Description
public static final String
NO_LOCATION

The default value of the location() attribute, which indicates that the schema generator will generate components in this namespace.

Method Summary

Modifier and TypeMethod and Description
public XmlNsForm
attributeFormDefault()

Namespace qualification for attributes.

public XmlNsForm
elementFormDefault()

Namespace qualification for elements.

public String
location()

Indicates that this namespace (specified by namespace()) has a schema already available exeternally, available at this location.

public String
namespace()

Name of the XML namespace.

public XmlNs[]
xmlns()

Customize the namespace URI, prefix associations.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Field Detail

NO_LOCATIONback to summary
public static final String NO_LOCATION

The default value of the location() attribute, which indicates that the schema generator will generate components in this namespace.

Method Detail

attributeFormDefaultback to summary
public XmlNsForm attributeFormDefault()

Namespace qualification for attributes. By default, attributesFormDefault will be absent from the XML Schema fragment.

elementFormDefaultback to summary
public XmlNsForm elementFormDefault()

Namespace qualification for elements. By default, element default attribute will be absent from the XML Schema fragment.

locationback to summary
public String location()

Indicates that this namespace (specified by namespace()) has a schema already available exeternally, available at this location.

This instructs the Jakarta XML Binding schema generators to simply refer to the pointed schema, as opposed to generating components into the schema. This schema is assumed to match what would be otherwise produced by the schema generator (same element names, same type names...)

This feature is intended to be used when a set of the Java classes is originally generated from an existing schema, hand-written to match externally defined schema, or the generated schema is modified manually.

Value could be any absolute URI, like http://example.org/some.xsd. It is also possible to specify the empty string, to indicate that the schema is externally available but the location is unspecified (and thus it's the responsibility of the reader of the generate schema to locate it.) Finally, the default value of this property "##generate" indicates that the schema generator is going to generate components for this namespace (as it did in Jakarta XML Binding.)

Multiple XmlSchema annotations on multiple packages are allowed to govern the same namespace(). In such case, all of them must have the same location() values.

Note to implementor

More precisely, the value must be either "", "##generate", or a valid lexical representation of xs:anyURI that begins with <scheme>:.

A schema generator is expected to generate a corresponding <xs:import namespace="..." schemaLocation="..."/> (or no schemaLocation attribute at all if the empty string is specified.) However, the schema generator is allowed to use a different value in the schemaLocation attribute (including not generating such attribute), for example so that the user can specify a local copy of the resource through the command line interface.

Since
1.6, JAXB 2.1
namespaceback to summary
public String namespace()

Name of the XML namespace.

xmlnsback to summary
public XmlNs[] xmlns()

Customize the namespace URI, prefix associations. By default, the namespace prefixes for a XML namespace are generated by a Jakarta XML Binding Provider in an implementation dependent way.