| java.lang.Object javax.xml.bind.JAXB
JAXB | final public class JAXB (Code) | | Class that defines convenience methods for common, simple use of JAXB.
Methods defined in this class are convenience methods that combine several basic operations
in the
JAXBContext ,
Unmarshaller , and
Marshaller .
They are designed
to be the prefered methods for developers new to JAXB. They have
the following characterstics:
- Generally speaking, the performance is not necessarily optimal.
It is expected that people who need to write performance
critical code will use the rest of the JAXB API directly.
- Errors that happen during the processing is wrapped into
DataBindingException (which will have
JAXBException as its
Throwable.getCause cause . It is expected that
people who prefer the checked exception would use
the rest of the JAXB API directly.
In addition, the unmarshal methods have the following characteristic:
- Schema validation is not performed on the input XML.
The processing will try to continue even if there
are errors in the XML, as much as possible. Only as
the last resort, this method fails with
DataBindingException .
Similarly, the marshal methods have the following characteristic:
- The processing will try to continue even if the Java object tree
does not meet the validity requirement. Only as
the last resort, this method fails with
DataBindingException .
All the methods on this class require non-null arguments to all parameters.
The unmarshal methods either fail with an exception or return
a non-null value.
author: Kohsuke Kawaguchi since: 2.1 |
Method Summary | |
public static void | marshal(Object jaxbObject, File xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, URL xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, URI xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, String xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, OutputStream xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, Writer xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static void | marshal(Object jaxbObject, Result xml) Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. | public static T | unmarshal(File xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(URL xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(URI xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(String xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(InputStream xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(Reader xml, Class<T> type) Reads in a Java object tree from the given XML input. | public static T | unmarshal(Source xml, Class<T> type) Reads in a Java object tree from the given XML input. |
marshal | public static void marshal(Object jaxbObject, File xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - XML will be written to this file. If it already exists,it will be overwritten. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, URL xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The XML will be URLConnection.getOutputStream sent to theresource pointed by this URL. Note that not all URLs supportsuch operation, and exact semantics depends on the URLimplementations. In case of HttpURLConnection HTTP URLs,this will perform HTTP POST. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, URI xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The URI is URI.toURL turned into URL and thenfollows the handling of URL. See above. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, String xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The string is first interpreted as an absolute URI.If it's not URI.isAbsolute a valid absolute URI,then it's interpreted as a File throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, OutputStream xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The XML will be sent to the given OutputStream.Upon a successful completion, the stream will be closed by this method. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, Writer xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The XML will be sent as a character stream to the given Writer.Upon a successful completion, the stream will be closed by this method. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
marshal | public static void marshal(Object jaxbObject, Result xml)(Code) | | Writes a Java object tree to XML and store it to the specified location.
Parameters: jaxbObject - The Java object to be marshalled into XML. If this object isa JAXBElement, it will provide the root tag name andthe body. If this object has XmlRootElementon its class definition, that will be used as the root tag nameand the given object will provide the body. Otherwise,the root tag name is Introspector.decapitalize(String) infered fromClass.getSimpleName the short class name.This parameter must not be null. Parameters: xml - The XML will be sent to the Result object. throws: DataBindingException - If the operation fails, such as due to I/O error, unbindable classes. |
unmarshal | public static T unmarshal(File xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - Reads the entire file as XML. |
unmarshal | public static T unmarshal(URL xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The resource pointed by the URL is read in its entirety. |
unmarshal | public static T unmarshal(URI xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The URI is URI.toURL turned into URL and thenfollows the handling of URL. |
unmarshal | public static T unmarshal(String xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The string is first interpreted as an absolute URI.If it's not URI.isAbsolute a valid absolute URI,then it's interpreted as a File |
unmarshal | public static T unmarshal(InputStream xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The entire stream is read as an XML infoset.Upon a successful completion, the stream will be closed by this method. |
unmarshal | public static T unmarshal(Reader xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The character stream is read as an XML infoset.The encoding declaration in the XML will be ignored.Upon a successful completion, the stream will be closed by this method. |
unmarshal | public static T unmarshal(Source xml, Class<T> type)(Code) | | Reads in a Java object tree from the given XML input.
Parameters: xml - The XML infoset that the Source represents is read. |
|
|