Class JMUnmarshallerImpl

public UnmarshallerHandler getUnmarshallerHandler()

Returns a SAX 2 org.xml.sax.ContentHandler, which is able to parse a SAX event stream and convert it into a JAXB object. This is particularly useful in a stack of SAX handlers. (Think of Apache Cocoon.)

Note: The JAXB provider may choose to return the same handler again, if the method is invoked more than once. In other words, if you need to have multiple handlers (for example, because you have multiple threads), then you should create multiple Unmarshallers.

Specified by:

getUnmarshallerHandler in interface Unmarshaller

public boolean isValidating()

Sets whether the Unmarshaller is validating the objects that it reads. The default is false.

Specified by:

isValidating in interface Unmarshaller

Returns:

True, if the Unmarshaller is validating the objects that it reads, false otherwise.

See Also:

Unmarshaller.setValidating(boolean)

public void setValidating(boolean pValidating)

Sets whether the Unmarshaller is validating the objects that it reads. The default is false.

Note: A validating unmarshaller will rarely use a validating SAX parser by default! It does so, because the SAX parsers validation and the Unmarshallers builtin validation would most probably validate the same things, resulting in no additional safety at the cost of wasting performance. Second, a SAX parser is not always in use. For example, you do not need a parser when converting a DOM Node. If you insist in a validating XML parser, then you should create your own org.xml.sax.XMLReader and use the method unmarshal(javax.xml.transform.Source).

Specified by:

setValidating in interface Unmarshaller

Parameters:

pValidating - Whether the Unmarshaller should validate or not.

public Object unmarshal(File pFile)
            throws JAXBException

public Object unmarshal(InputSource pSource)
            throws JAXBException

The Unmarshaller reads the byte stream or character stream referred by the org.xml.sax.InputSource and converts it into an equivalent JAXB object.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

pSource - The InputSource referring to a byte or character stream. It is recommended, that the system ID is set. This may be required, if the XML in the stream refers to external entities.

Returns:

The JAXB object read from the byte or character stream.

Throws:

JAXBException - An unexpected problem (for example an IOException) occurred.

public Object unmarshal(InputStream pStream)
            throws JAXBException

public Object unmarshal(Node pNode)
            throws JAXBException

The Unmarshaller converts the given node into an equivalent JAXB object.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

pNode - The node to convert. The JAXB provider must support documents and elements. Other node types may not work (document fragments) or cannot work (attributes, text nodes, and so on).

Returns:

The JAXB object read from the DOM node.

Throws:

JAXBException - An unexpected problem occurred.

public Object unmarshal(Source pSource)
            throws JAXBException

The Unmarshaller reads the XML representation from the given Source and converts it into an equivalent JAXB object.

The JAXB provider must support at least javax.xml.transform.sax.SAXSource, javax.xml.transform.dom.DOMSource, and javax.xml.transform.stream.StreamSource. A possible implementation could validate whether the argument is actually an instance of these subinterfaces. If so, it might simply act like Unmarshaller.getUnmarshallerHandler(), unmarshal(org.w3c.dom.Node), Unmarshaller.unmarshal(InputStream), or unmarshal(org.xml.sax.InputSource), respectively.

Note: If you are not using the standard JAXP mechanism for obtaining an org.xml.sax.XMLReader, then you might create your own SAX parser and invoke the pSource arguments javax.xml.transform.sax.SAXSource.setXMLReader(org.xml.sax.XMLReader). The JAXB provider will detect and use your SAX parser.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

pSource - The Source being read.

Returns:

The JAXB object read from the DOM node.

Throws:

JAXBException - An unexpected problem occurred.

public Object unmarshal(URL pURL)
            throws JAXBException