File	Doc	Category	Size	Date	Package
JAXBContext.java	API Doc	Java SE 6 API	29011	Tue Jun 10 00:27:04 BST 2008	javax.xml.bind

JAXBContext

• java.lang.Object

Fields Summary
public static final String	JAXB_CONTEXT_FACTORY The name of the property that contains the name of the class capable of creating new JAXBContext objects.

Constructors Summary
protected JAXBContext()

Methods Summary
public javax.xml.bind.Binder	createBinder(java.lang.Class domType) Creates a Binder object that can be used for associative/in-place unmarshalling/marshalling. param domType select the DOM API to use by passing in its DOM Node class. return always a new valid Binder object. throws UnsupportedOperationException if DOM API corresponding to domType is not supported by the implementation. since JAXB2.0 // to make JAXB 1.0 implementations work, this method must not be // abstract throw new UnsupportedOperationException();
public javax.xml.bind.Binder	createBinder() Creates a Binder for W3C DOM. return always a new valid Binder object. since JAXB2.0 return createBinder(Node.class);
public javax.xml.bind.JAXBIntrospector	createJAXBIntrospector() Creates a JAXBIntrospector object that can be used to introspect JAXB objects. return always return a non-null valid JAXBIntrospector object. throws UnsupportedOperationException Calling this method on JAXB 1.0 implementations will throw an UnsupportedOperationException. since JAXB2.0 // to make JAXB 1.0 implementations work, this method must not be // abstract throw new UnsupportedOperationException();
public abstract javax.xml.bind.Marshaller	createMarshaller() Create a Marshaller object that can be used to convert a java content tree into XML data. return a Marshaller object throws JAXBException if an error was encountered while creating the Marshaller object
public abstract javax.xml.bind.Unmarshaller	createUnmarshaller() Create an Unmarshaller object that can be used to convert XML data into a java content tree. return an Unmarshaller object throws JAXBException if an error was encountered while creating the Unmarshaller object
public abstract javax.xml.bind.Validator	createValidator() {@link Validator} has been made optional and deprecated in JAXB 2.0. Please refer to the javadoc for {@link Validator} for more detail. Create a Validator object that can be used to validate a java content tree against its source schema. return a Validator object throws JAXBException if an error was encountered while creating the Validator object deprecated since JAXB2.0
public void	generateSchema(javax.xml.bind.SchemaOutputResolver outputResolver) Generates the schema documents for this context. param outputResolver this object controls the output to which schemas will be sent. throws IOException if {@link SchemaOutputResolver} throws an {@link IOException}. throws UnsupportedOperationException Calling this method on JAXB 1.0 implementations will throw an UnsupportedOperationException. since JAXB 2.0 // to make JAXB 1.0 implementations work, this method must not be // abstract throw new UnsupportedOperationException();
public static javax.xml.bind.JAXBContext	newInstance(java.lang.String contextPath) Obtain a new instance of a JAXBContext class. This is a convenience method for the {@link #newInstance(String,ClassLoader) newInstance} method. It uses the context class loader of the current thread. To specify the use of a different class loader, either set it via the Thread.setContextClassLoader() api or use the {@link #newInstance(String,ClassLoader) newInstance} method. throws JAXBException if an error was encountered while creating the JAXBContext such as failure to locate either ObjectFactory.class or jaxb.index in the packages an ambiguity among global elements contained in the contextPath failure to locate a value for the context factory provider property mixing schema derived packages from different providers on the same contextPath //return newInstance( contextPath, JAXBContext.class.getClassLoader() ); return newInstance( contextPath, Thread.currentThread().getContextClassLoader() );
public static javax.xml.bind.JAXBContext	newInstance(java.lang.String contextPath, java.lang.ClassLoader classLoader) Obtain a new instance of a JAXBContext class. The client application must supply a context path which is a list of colon (':', \u005Cu003A) separated java package names that contain schema-derived classes and/or fully qualified JAXB-annotated classes. Schema-derived code is registered with the JAXBContext by the ObjectFactory.class generated per package. Alternatively than being listed in the context path, programmer annotated JAXB mapped classes can be listed in a jaxb.index resource file, format described below. Note that a java package can contain both schema-derived classes and user annotated JAXB classes. Additionally, the java package may contain JAXB package annotations that must be processed. (see JLS 3rd Edition, Section 7.4.1. "Package Annotations"). Every package listed on the contextPath must meet one or both of the following conditions otherwise a JAXBException will be thrown: it must contain ObjectFactory.class it must contain jaxb.index Format for jaxb.index The file contains a newline-separated list of class names. Space and tab characters, as well as blank lines, are ignored. The comment character is '#' (0x23); on each line all characters following the first comment character are ignored. The file must be encoded in UTF-8. Classes that are reachable, as defined in {@link #newInstance(Class...)}, from the listed classes are also registered with JAXBContext. Constraints on class name occuring in a jaxb.index file are: Must not end with ".class". Class names are resolved relative to package containing jaxb.index file. Only classes occuring directly in package containing jaxb.index file are allowed. Fully qualified class names are not allowed. A qualified class name,relative to current package, is only allowed to specify a nested or inner class. To maintain compatibility with JAXB 1.0 schema to java interface/implementation binding, enabled by schema customization , the JAXB provider will ensure that each package on the context path has a jaxb.properties file which contains a value for the javax.xml.bind.context.factory property and that all values resolve to the same provider. This requirement does not apply to JAXB annotated classes. If there are any global XML element name collisions across the various packages listed on the contextPath, a JAXBException will be thrown. Mixing generated interface/impl bindings from multiple JAXB Providers in the same context path may result in a JAXBException being thrown. param contextPath list of java package names that contain schema derived class and/or java to schema (JAXB-annotated) mapped classes param classLoader This class loader will be used to locate the implementation classes. return a new instance of a JAXBContext throws JAXBException if an error was encountered while creating the JAXBContext such as failure to locate either ObjectFactory.class or jaxb.index in the packages an ambiguity among global elements contained in the contextPath failure to locate a value for the context factory provider property mixing schema derived packages from different providers on the same contextPath return newInstance(contextPath,classLoader,Collections.<String,Object>emptyMap());
public static javax.xml.bind.JAXBContext	newInstance(java.lang.String contextPath, java.lang.ClassLoader classLoader, java.util.Map properties) Obtain a new instance of a JAXBContext class. This is mostly the same as {@link JAXBContext#newInstance(String, ClassLoader)}, but this version allows you to pass in provider-specific properties to configure the instanciation of {@link JAXBContext}. The interpretation of properties is up to implementations. param contextPath list of java package names that contain schema derived classes param classLoader This class loader will be used to locate the implementation classes. param properties provider-specific properties return a new instance of a JAXBContext throws JAXBException if an error was encountered while creating the JAXBContext such as failure to locate either ObjectFactory.class or jaxb.index in the packages an ambiguity among global elements contained in the contextPath failure to locate a value for the context factory provider property mixing schema derived packages from different providers on the same contextPath since JAXB2.0 return ContextFinder.find( /* The default property name according to the JAXB spec */ JAXB_CONTEXT_FACTORY, /* the context path supplied by the client app */ contextPath, /* class loader to be used */ classLoader, properties );
public static javax.xml.bind.JAXBContext	newInstance(java.lang.Class classesToBeBound) Obtain a new instance of a JAXBContext class. The client application must supply a list of classes that the new context object needs to recognize. Not only the new context will recognize all the classes specified, but it will also recognize any classes that are directly/indirectly referenced statically from the specified classes. Subclasses of referenced classes nor @XmlTransient referenced classes are not registered with JAXBContext. For example, in the following Java code, if you do newInstance(Foo.class), the newly created {@link JAXBContext} will recognize both Foo and Bar, but not Zot or FooBar: class Foo { @XmlTransient FooBar c; Bar b; } class Bar { int x; } class Zot extends Bar { int y; } class FooBar { } Therefore, a typical client application only needs to specify the top-level classes, but it needs to be careful. Note that for each java package registered with JAXBContext, when the optional package annotations exist, they must be processed. (see JLS 3rd Edition, Section 7.4.1. "Package Annotations"). param classesToBeBound list of java classes to be recognized by the new {@link JAXBContext}. Can be empty, in which case a {@link JAXBContext} that only knows about spec-defined classes will be returned. return A new instance of a JAXBContext. Always non-null valid object. throws JAXBException if an error was encountered while creating the JAXBContext, such as (but not limited to): No JAXB implementation was discovered Classes use JAXB annotations incorrectly Classes have colliding annotations (i.e., two classes with the same type name) The JAXB implementation was unable to locate provider-specific out-of-band information (such as additional files generated at the development time.) throws IllegalArgumentException if the parameter contains {@code null} (i.e., {@code newInstance(null);}) since JAXB2.0 return newInstance(classesToBeBound,Collections.<String,Object>emptyMap());
public static javax.xml.bind.JAXBContext	newInstance(java.lang.Class[] classesToBeBound, java.util.Map properties) Obtain a new instance of a JAXBContext class. An overloading of {@link JAXBContext#newInstance(Class...)} to configure 'properties' for this instantiation of {@link JAXBContext}. The interpretation of properties is implementation specific. param classesToBeBound list of java classes to be recognized by the new {@link JAXBContext}. Can be empty, in which case a {@link JAXBContext} that only knows about spec-defined classes will be returned. return A new instance of a JAXBContext. Always non-null valid object. throws JAXBException if an error was encountered while creating the JAXBContext, such as (but not limited to): No JAXB implementation was discovered Classes use JAXB annotations incorrectly Classes have colliding annotations (i.e., two classes with the same type name) The JAXB implementation was unable to locate provider-specific out-of-band information (such as additional files generated at the development time.) throws IllegalArgumentException if the parameter contains {@code null} (i.e., {@code newInstance(null);}) since JAXB2.0 // empty class list is not an error, because the context will still include // spec-specified classes like String and Integer. // if(classesToBeBound.length==0) // throw new IllegalArgumentException(); // but it is an error to have nulls in it. for( int i=classesToBeBound.length-1; i>=0; i-- ) if(classesToBeBound[i]==null) throw new IllegalArgumentException(); return ContextFinder.find(classesToBeBound,properties);