jakarta.xml.bind

public Interface UnmarshallerHandler

Imports: org.xml.sax.ContentHandler

Unmarshaller implemented as SAX ContentHandler.

Applications can use this interface to use their Jakarta XML Binding provider as a component in an XML pipeline. For example:

      JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );

      Unmarshaller unmarshaller = context.createUnmarshaller();

      UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();

      SAXParserFactory spf = SAXParserFactory.newInstance();
      spf.setNamespaceAware( true );

      XMLReader xmlReader = spf.newSAXParser().getXMLReader();
      xmlReader.setContentHandler( unmarshallerHandler );
      xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );

      MyObject myObject= (MyObject)unmarshallerHandler.getResult();

This interface is reusable: even if the user fails to unmarshal an object, s/he can still start a new round of unmarshalling.

Author

Kohsuke KAWAGUCHI, Sun Microsystems, Inc.

Since

1.6, JAXB 1.0

See Also

Unmarshaller#getUnmarshallerHandler()

Method Summary

Modifier and Type	Method and Description
public Object	Returns: always return a non-null valid object which was unmarshalled. getResult() Obtains the unmarshalled result.

Inherited from org.xml.sax.ContentHandler:: characters declaration endDocument endElement endPrefixMapping ignorableWhitespace processingInstruction setDocumentLocator skippedEntity startDocument startElement startPrefixMapping

Method Detail

getResult	back to summary
public Object getResult() throws JAXBException, IllegalStateException Obtains the unmarshalled result. This method can be called only after this handler receives the endDocument SAX event. Returns:Object always return a non-null valid object which was unmarshalled. Exceptions JAXBException: if there is any unmarshalling error. Note that the implementation is allowed to throw SAXException during the parsing when it finds an error. IllegalStateException: if this method is called before this handler receives the endDocument event.

getResult

back to summary

public Object getResult() throws JAXBException, IllegalStateException

Obtains the unmarshalled result. This method can be called only after this handler receives the endDocument SAX event.

Returns:Object

always return a non-null valid object which was unmarshalled.

Exceptions

JAXBException:: if there is any unmarshalling error. Note that the implementation is allowed to throw SAXException during the parsing when it finds an error.
IllegalStateException:: if this method is called before this handler receives the endDocument event.