FileDocCategorySizeDatePackage
UnmarshallerHandler.javaAPI DocJava SE 6 API2163Tue Jun 10 00:27:04 BST 2008javax.xml.bind

UnmarshallerHandler

public interface UnmarshallerHandler implements ContentHandler
Unmarshaller implemented as SAX ContentHandler.

Applications can use this interface to use their JAXB 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.
version
$Revision: 1.1 $ $Date: 2004/12/14 21:50:41 $
see
Unmarshaller#getUnmarshallerHandler()
since
JAXB1.0

Fields Summary
Constructors Summary
Methods Summary
public java.lang.ObjectgetResult()
Obtains the unmarshalled result. This method can be called only after this handler receives the endDocument SAX event.

exception
IllegalStateException if this method is called before this handler receives the endDocument event.
exception
JAXBException if there is any unmarshalling error. Note that the implementation is allowed to throw SAXException during the parsing when it finds an error.
return
always return a non-null valid object which was unmarshalled.