EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jaxb
Class JAXBUnmarshallerHandler

java.lang.Object
  extended by org.eclipse.persistence.platform.xml.SAXDocumentBuilder
      extended by org.eclipse.persistence.jaxb.JAXBUnmarshallerHandler
All Implemented Interfaces:
UnmarshallerHandler, org.eclipse.persistence.internal.oxm.record.ExtendedContentHandler, org.xml.sax.ContentHandler

public class JAXBUnmarshallerHandler
extends SAXDocumentBuilder
implements UnmarshallerHandler

Implementation of UnmarshallerHandler to be used by JAXBUnmarshaller.

See Also:
JAXBUnmarshaller, UnmarshallerHandler

Field Summary
 
Fields inherited from class org.eclipse.persistence.platform.xml.SAXDocumentBuilder
document, locator, namespaceDeclarations, nodes, stringBuffer, xmlPlatform
 
Constructor Summary
JAXBUnmarshallerHandler(JAXBUnmarshaller newXMLUnmarshaller)
          Create a new JAXBUnmarshallerHandler with the specified JAXBUnmarshaller
 
Method Summary
 void endDocument()
          Event that is called at the end of processing the document.
 java.lang.Object getResult()
          Return the unmarhalled document.
 void startDocument()
          Event that is called at the start of processing the document.
 
Methods inherited from class org.eclipse.persistence.platform.xml.SAXDocumentBuilder
addNamespaceDeclaration, appendChildNode, characters, characters, endElement, endPrefixMapping, getDocument, getInitializedDocument, ignorableWhitespace, processingInstruction, setDocumentLocator, setNil, skippedEntity, startElement, startPrefixMapping
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.xml.sax.ContentHandler
characters, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startElement, startPrefixMapping
 

Constructor Detail

JAXBUnmarshallerHandler

public JAXBUnmarshallerHandler(JAXBUnmarshaller newXMLUnmarshaller)
Create a new JAXBUnmarshallerHandler with the specified JAXBUnmarshaller

Parameters:
newXMLUnmarshaller - the JAXBUnmarshaller.
Method Detail

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Event that is called at the end of processing the document.

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class SAXDocumentBuilder
Throws:
org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Event that is called at the start of processing the document.

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class SAXDocumentBuilder
Throws:
org.xml.sax.SAXException

getResult

public java.lang.Object getResult()
                           throws JAXBException,
                                  java.lang.IllegalStateException
Return the unmarhalled document. If the document is null or the endDocument was never called then an IllegalStateExcpetion will be thrown.

Specified by:
getResult in interface UnmarshallerHandler
Returns:
always return a non-null valid object which was unmarshalled.
Throws:
JAXBException - if there is any unmarshalling error. Note that the implementation is allowed to throw SAXException during the parsing when it finds an error.
java.lang.IllegalStateException - if this method is called before this handler receives the endDocument event.

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference