| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.xml.bind.helpers.AbstractUnmarshallerImpl
This is an abstract default implementation of an
 Unmarshaller. Subclasses only need to implement
 Unmarshaller.getUnmarshallerHandler(),
 Unmarshaller.unmarshal(org.w3c.dom.Node), and
 unmarshal(org.xml.sax.XMLReader, org.xml.sax.InputSource).
| Constructor Summary | |
| AbstractUnmarshallerImpl()Creates a new instance of AbstractUnmarshallerImpl. | |
| Method Summary | |
| protected  UnmarshalException | createUnmarshalException(org.xml.sax.SAXException pException)Helper method to concert a SAXExceptioninto anUnmarshalException. | 
|  ValidationEventHandler | getEventHandler()If the JAXB application has registered a custom handler for validation events, returns that handler. | 
|  java.lang.Object | getProperty(java.lang.String pName)Always throws a PropertyException,
 because the default implementation does not support any
 properties. | 
| protected  org.xml.sax.XMLReader | getXMLReader()Creates a configured XMLReader. | 
|  boolean | isValidating()Sets whether the Unmarshalleris validating
 the objects that it reads. | 
|  void | setEventHandler(ValidationEventHandler pHandler)An application may customize the Unmarshallers behaviour in case of validation problems by supplying a custom handler for validation events. | 
|  void | setProperty(java.lang.String pName,
            java.lang.Object pValue)Always throws a PropertyException,
 because the default implementation does not support any
 properties. | 
|  void | setValidating(boolean pValidating)Sets whether the Unmarshalleris validating
 the objects that it reads. | 
|  java.lang.Object | unmarshal(java.io.File pFile)This method takes opens the given file pFilefor input. | 
|  java.lang.Object | unmarshal(org.xml.sax.InputSource pSource)The Unmarshaller reads the byte stream or character stream referred by the InputSourceand converts it into an equivalent JAXB object. | 
|  java.lang.Object | unmarshal(java.io.InputStream pSource)The Unmarshaller reads the given byte stream and converts it into an equivalent JAXB object. | 
|  java.lang.Object | unmarshal(javax.xml.transform.Source pSource)The Unmarshaller reads the XML representation from the given Sourceand converts it into an equivalent JAXB object. | 
|  java.lang.Object | unmarshal(java.net.URL pURL)This method takes connects to the given pURLand opens a byte stream for input. | 
| protected abstract  java.lang.Object | unmarshal(org.xml.sax.XMLReader pReader,
          org.xml.sax.InputSource pSource)Unmarshals an object by using the given instance of XMLReaderto parse the XML
 document read from the byte or character stream
 given by theInputSourcepSource. | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface javax.xml.bind.Unmarshaller | 
| getUnmarshallerHandler, unmarshal | 
| Constructor Detail | 
public AbstractUnmarshallerImpl()
Creates a new instance of AbstractUnmarshallerImpl.
| Method Detail | 
protected org.xml.sax.XMLReader getXMLReader()
                                      throws JAXBException
Creates a configured XMLReader.
 Unmarshaller is not re-entrant, so we will use a single instance
 of XMLReader.
JAXBException - Encapsulates a
   ParserConfigurationException
public java.lang.Object unmarshal(javax.xml.transform.Source pSource)
                           throws JAXBException
UnmarshallerThe Unmarshaller reads the XML representation from the given
 Source and converts it into an equivalent JAXB object.
The JAXB provider must support at least
 SAXSource,
 DOMSource, and
 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(),
 Unmarshaller.unmarshal(org.w3c.dom.Node),
 Unmarshaller.unmarshal(java.io.InputStream), or
 Unmarshaller.unmarshal(org.xml.sax.InputSource), respectively.
Note: If you are not using the standard JAXP
 mechanism for obtaining an XMLReader,
 then you might create your own SAX parser and invoke the
 pSource arguments
 SAXSource.setXMLReader(org.xml.sax.XMLReader).
 The JAXB provider will detect and use your SAX parser.
unmarshal in interface UnmarshallerpSource - The Source being read.
JAXBException - An unexpected problem occurred.
protected abstract java.lang.Object unmarshal(org.xml.sax.XMLReader pReader,
                                              org.xml.sax.InputSource pSource)
                                       throws JAXBException
Unmarshals an object by using the given instance
 of XMLReader to parse the XML
 document read from the byte or character stream
 given by the InputSource
 pSource.
The implementation should call the method
 XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)
 in order to pass errors provided by the SAX parser to the
 ValidationEventHandler provided by
 the client.
JAXBException - An error occurred while unmarshalling
   the JAXB object.
public final java.lang.Object unmarshal(org.xml.sax.InputSource pSource)
                                 throws JAXBException
UnmarshallerThe Unmarshaller reads the byte stream or character
 stream referred by the InputSource
 and converts it into an equivalent JAXB object.
unmarshal in interface UnmarshallerpSource - 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.
JAXBException - An unexpected problem (for example an
   IOException) occurred.
public final java.lang.Object unmarshal(java.net.URL pURL)
                                 throws JAXBException
UnmarshallerThis method takes connects to the given pURL
 and opens a byte stream for input. The Unmarshaller reads the
 byte stream and converts it into an equivalent JAXB object.
unmarshal in interface UnmarshallerpURL - The URL being read.
JAXBException - An unexpected problem (for example an
   IOException) occurred.
public final java.lang.Object unmarshal(java.io.File pFile)
                                 throws JAXBException
UnmarshallerThis method takes opens the given file pFile
 for input. The Unmarshaller reads the byte stream contained in
 the file and converts it into an equivalent JAXB object.
unmarshal in interface UnmarshallerpFile - The file being read.
JAXBException - An unexpected problem (for example an
   IOException) occurred.
public final java.lang.Object unmarshal(java.io.InputStream pSource)
                                 throws JAXBException
UnmarshallerThe Unmarshaller reads the given byte stream and converts it into an equivalent JAXB object.
unmarshal in interface UnmarshallerpSource - The stream being read.
JAXBException - An unexpected problem (for example an
   IOException) occurred.
public boolean isValidating()
                     throws JAXBException
UnmarshallerSets whether the Unmarshaller is validating
 the objects that it reads. The default is false.
isValidating in interface UnmarshallerUnmarshaller is validating the objects
   that it reads, false otherwise.
JAXBException - Fetching the property value failed.Unmarshaller.setValidating(boolean)
public void setValidating(boolean pValidating)
                   throws JAXBException
UnmarshallerSets 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
 XMLReader and use the method
 Unmarshaller.unmarshal(javax.xml.transform.Source).
setValidating in interface UnmarshallerpValidating - Whether the Unmarshaller should validate
   or not.
JAXBException - Setting the property failed.
public ValidationEventHandler getEventHandler()
                                       throws JAXBException
UnmarshallerIf the JAXB application has registered a custom handler for validation events, returns that handler. Otherwise returns the default handler, which is triggering an exception in case of errors and fatal errors.
getEventHandler in interface UnmarshallerJAXBException
public void setEventHandler(ValidationEventHandler pHandler)
                     throws JAXBException
UnmarshallerAn application may customize the Unmarshallers behaviour in case of validation problems by supplying a custom handler for validation events. The default handler will trigger an exception in case of errors and fatal errors.
setEventHandler in interface UnmarshallerpHandler - The custom event handler or null to restore
   the default event handler.
JAXBException - Setting the handler failed.protected UnmarshalException createUnmarshalException(org.xml.sax.SAXException pException)
Helper method to concert a SAXException
 into an UnmarshalException.
pException - If the parameter contains a nested instance of
   UnmarshalException, throws that instance.
   Otherwise wraps the parameter in a new
   UnmarshalException and throws that.
public void setProperty(java.lang.String pName,
                        java.lang.Object pValue)
                 throws PropertyException
Always throws a PropertyException,
 because the default implementation does not support any
 properties. If you want to change this, override the class.
setProperty in interface UnmarshallerpName - The property name.
java.lang.IllegalArgumentException - The property name was null.
PropertyException - The name was not null. :-)
public java.lang.Object getProperty(java.lang.String pName)
                             throws PropertyException
Always throws a PropertyException,
 because the default implementation does not support any
 properties. If you want to change this, override the class.
getProperty in interface UnmarshallerpName - The property name.
java.lang.IllegalArgumentException - The property name was null.
PropertyException - The name was not null. :-)| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||