org.exolab.castor.xml
public final class UnmarshalHandler extends MarshalFramework implements ContentHandler, DocumentHandler, ErrorHandler
Version: $Revision: 6392 $ $Date: 2006-05-25 06:41:12 -0600 (Thu, 25 May 2006) $
Nested Class Summary | |
---|---|
class | UnmarshalHandler.Arguments
Internal class used for passing constructor argument
information |
static class | UnmarshalHandler.ArrayHandler
A class for handling Arrays during unmarshalling.
|
class | UnmarshalHandler.ElementInfo
A utility class for keeping track of the
qName and how the SAX parser passed attributes |
class | UnmarshalHandler.IDResolverImpl
Local IDResolver
|
class | UnmarshalHandler.ReferenceInfo
Internal class used to save state for reference resolving
|
Constructor Summary | |
---|---|
protected | UnmarshalHandler()
Creates a new UnmarshalHandler
The "root" class will be obtained by looking into the mapping
for a descriptor that matches the root element.
|
protected | UnmarshalHandler(Class _class)
Creates a new UnmarshalHandler
|
Method Summary | |
---|---|
void | addNamespaceToPackageMapping(String nsURI, String packageName)
Adds a mapping from the given namespace URI to the given
package name
|
void | characters(char[] ch, int start, int length) |
void | endDocument() |
void | endElement(String name) |
void | endElement(String namespaceURI, String localName, String qName) ContentHandler#endElement Signals the end of an element |
void | endPrefixMapping(String prefix)
Signals to end the namespace prefix mapping
|
void | error(SAXParseException exception) |
void | fatalError(SAXParseException exception) |
Object | getCurrentObject()
Returns the Object that the UnmarshalHandler is currently
handling (within the object model), or null if the current
element is a simpleType.
|
Locator | getDocumentLocator() |
Object | getObject()
Returns the "root" Object (ie. the entire object model)
being unmarshalled.
|
ObjectFactory | getObjectFactory()
Returns the ObjectFactory instance in use. |
void | ignorableWhitespace(char[] ch, int start, int length) |
void | processingInstruction(String target, String data) |
void | setClassLoader(ClassLoader loader)
Sets the ClassLoader to use when loading classes
|
void | setClearCollections(boolean clear)
Sets whether or not to clear collections (including arrays)
upon first use to remove default values. |
protected void | setConfiguration(Configuration config)
Sets the current Castor configuration. |
void | setDebug(boolean debug)
Turns debuging on or off. |
void | setDocumentLocator(Locator locator) |
void | setIDResolver(IDResolver idResolver)
Sets the IDResolver to use when resolving IDREFs for
which no associated element may exist in XML document.
|
void | setIgnoreExtraAttributes(boolean ignoreExtraAtts)
Sets whether or not attributes that do not match
a specific field should simply be ignored or
reported as an error. |
void | setIgnoreExtraElements(boolean ignoreExtraElems)
Sets whether or not elements that do not match
a specific field should simply be ignored or
reported as an error. |
void | setLogWriter(PrintWriter printWriter)
Sets the PrintWriter used for printing log messages |
void | setObjectFactory(ObjectFactory objectFactory)
Sets a (custom) ObjectFactory instance. |
void | setResolver(XMLClassDescriptorResolver cdResolver)
Sets the ClassDescriptorResolver to use for loading and
resolving ClassDescriptors
|
void | setReuseObjects(boolean reuse)
Sets a boolean that when true indicates that objects
contained within the object model should be re-used
where appropriate. |
void | setRootObject(Object root)
Sets the root (top-level) object to use for unmarshalling into.
|
void | setUnmarshalListener(UnmarshalListener listener)
Sets an UnmarshalListener.
|
void | setValidation(boolean validate)
Sets the flag for validation.
|
void | setWhitespacePreserve(boolean preserve)
Sets the top-level whitespace (xml:space) to either
preserving or non preserving. |
void | skippedEntity(String name)
Signals that an entity was skipped by the parser
|
void | startDocument()
Signals the start of a new document |
void | startElement(String namespaceURI, String localName, String qName, Attributes atts) ContentHandler#startElement Signals the start of element. |
void | startElement(String name, AttributeList attList) DocumentHandler#startElement Signals the start of element. |
void | startPrefixMapping(String prefix, String uri)
Signals to start the namespace - prefix mapping
|
static Object | toPrimitiveObject(Class type, String value)
Converts a String to the given primitive object type
|
void | warning(SAXParseException exception) |
Parameters: _class the Class to create the UnmarshalHandler for
Parameters: nsURI the namespace URI to map from packageName the package name to map to
ContentHandler#endElement
Signals the end of an elementParameters: localName The name of the element.
Parameters: prefix the namespace prefix
Returns: the Object currently being unmarshalled, or null if the current element is a simpleType.
Returns: the root Object being unmarshalled.
Returns: the ObjectFactory instance in use.
Parameters: loader the ClassLoader to use
Parameters: clear the boolean value that when true indicates collections should be cleared upon first use.
Parameters: debug the flag indicating whether to generate debug information. A value of true, will turn debuggin on.
See Also: UnmarshalHandler
Parameters: idResolver the IDResolver to use when resolving IDREFs for which no associated element may exist in the XML document.
Parameters: ignoreExtraAtts a boolean that when true will allow non-matched attributes to simply be ignored.
Parameters: ignoreExtraElems a boolean that when true will allow non-matched attributes to simply be ignored.
Parameters: printWriter the PrintWriter to use when printing log messages
Parameters: objectFactory A (custom) ObjectFactory instance
Parameters: cdResolver the ClassDescriptorResolver to use
Parameters: reuse the boolean indicating whether or not to re-use existing objects in the object model.
Parameters: root the instance to unmarshal into.
Parameters: listener the UnmarshalListener to use with this instance of the UnmarshalHandler.
Parameters: validate A boolean to indicate whether or not validation should be done
during umarshalling.
By default, validation will be performed.
Parameters: preserve a boolean that when true enables whitespace preserving by default.
Parameters: name the skipped entity's name
ContentHandler#startElement
Signals the start of element.Parameters: localName The name of the element. atts The AttributeList containing the associated attributes for the element.
DocumentHandler#startElement
Signals the start of element.Parameters: name The name of the element. attList The AttributeList containing the associated attributes for the element.
Parameters: prefix the namespace prefix to map uri the namespace URI
Parameters: type the class type of the primitive in which to convert the String to value the String to convert to a primitive
Returns: the new primitive Object