Class JAXB
- java.lang.Object
-
- javax.xml.bind.JAXB
public final class JAXB extends Object
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 haveJAXBException
as itscause
. 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.
- Since:
- 2.1
Methods
Modifier and Type | Method and Description |
---|---|
static void |
marshal(Object jaxbObject,
File xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
OutputStream xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
Result xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
String xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
URI xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
URL xml) Writes a Java object tree to XML and store it to the specified location. |
static void |
marshal(Object jaxbObject,
Writer xml) Writes a Java object tree to XML and store it to the specified location. |
static <T> T |
unmarshal(File xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(InputStream xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(Reader xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(Source xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(String xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(URI xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
static <T> T |
unmarshal(URL xml,
Class<T> type) Reads in a Java object tree from the given XML input. |
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods
unmarshal
public static <T> T unmarshal(File xml, Class<T> type)
Reads in a Java object tree from the given XML input.
- Parameters:
-
xml
- Reads the entire file as XML.
unmarshal
public static <T> T unmarshal(URL xml, Class<T> type)
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> T unmarshal(URI xml, Class<T> type)
Reads in a Java object tree from the given XML input.
- Parameters:
-
xml
- The URI isturned into URL
and then follows the handling ofURL
.
unmarshal
public static <T> T unmarshal(String xml, Class<T> type)
Reads in a Java object tree from the given XML input.
- Parameters:
-
xml
- The string is first interpreted as an absoluteURI
. If it's nota valid absolute URI
, then it's interpreted as aFile
unmarshal
public static <T> T unmarshal(InputStream xml, Class<T> type)
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> T unmarshal(Reader xml, Class<T> type)
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> T unmarshal(Source xml, Class<T> type)
Reads in a Java object tree from the given XML input.
- Parameters:
-
xml
- The XML infoset that theSource
represents is read.
marshal
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. If this object is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
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)
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 is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The XML will besent
to the resource pointed by this URL. Note that not allURL
s support such operation, and exact semantics depends on theURL
implementations. In case ofHTTP 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)
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 is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The URI isturned into URL
and then follows the handling ofURL
. 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)
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 is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The string is first interpreted as an absoluteURI
. If it's nota valid absolute URI
, then it's interpreted as aFile
- Throws:
-
DataBindingException
- If the operation fails, such as due to I/O error, unbindable classes.
marshal
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. If this object is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The XML will be sent to the givenOutputStream
. 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)
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 is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The XML will be sent as a character stream to the givenWriter
. 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)
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 is aJAXBElement
, it will provide the root tag name and the body. If this object hasXmlRootElement
on its class definition, that will be used as the root tag name and the given object will provide the body. Otherwise, the root tag name isinfered
fromthe short class name
. This parameter must not be null. -
xml
- The XML will be sent to theResult
object. - Throws:
-
DataBindingException
- If the operation fails, such as due to I/O error, unbindable classes.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/JAXB.html