com.sun.xml.bind.v2.runtime.unmarshaller
Class ValidatingUnmarshaller

java.lang.Object
  com.sun.xml.bind.v2.runtime.unmarshaller.ValidatingUnmarshaller

All Implemented Interfaces:

XmlVisitor, XmlVisitor.TextPredictor

final class ValidatingUnmarshaller
extends java.lang.Object
implements XmlVisitor, XmlVisitor.TextPredictor

XmlVisitor decorator that validates the events by using JAXP validation API.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.xml.bind.v2.runtime.unmarshaller.XmlVisitor

XmlVisitor.TextPredictor

Constructor Summary

ValidatingUnmarshaller(javax.xml.validation.Schema schema, XmlVisitor next)
Creates a new instance of ValidatingUnmarshaller.

Method Summary

void	endDocument()
void	endElement(TagName tagName)
void	endPrefixMapping(java.lang.String prefix) Called after XmlVisitor.endElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName) event to notify the end of a binding.
boolean	expectText() Deprecated.
UnmarshallingContext	getContext() Returns the UnmarshallingContext at the end of the chain.
XmlVisitor.TextPredictor	getPredictor() Gets the predictor that can be used for the caller to avoid calling XmlVisitor.text(CharSequence) unnecessarily.
void	startDocument(LocatorEx locator, javax.xml.namespace.NamespaceContext nsContext) Notifies a start of the document.
void	startElement(TagName tagName) Notifies a start tag of a new element.
void	startPrefixMapping(java.lang.String prefix, java.lang.String nsUri) Called before XmlVisitor.startElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName) event to notify a new namespace binding.
void	text(java.lang.CharSequence pcdata) Text events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidatingUnmarshaller

public ValidatingUnmarshaller(javax.xml.validation.Schema schema,
                              XmlVisitor next)

Creates a new instance of ValidatingUnmarshaller.

Method Detail

startDocument

public void startDocument(LocatorEx locator,
                          javax.xml.namespace.NamespaceContext nsContext)
                   throws org.xml.sax.SAXException

Description copied from interface: XmlVisitor

Notifies a start of the document.

Specified by:

startDocument in interface XmlVisitor

Parameters:

locator - This live object returns the location information as the parsing progresses. must not be null.

nsContext - Some broken XML APIs can't iterate all the in-scope namespace bindings, which makes it impossible to emulate XmlVisitor.startPrefixMapping(String, String) correctly when unmarshalling a subtree. Connectors that use such an API can pass in additional NamespaceContext object that knows about the in-scope namespace bindings. Otherwise (and normally) it is null.

Ideally this object should be immutable and only represent the namespace URI bindings in the context (those done above the element that JAXB started unmarshalling), but it can also work even if it changes as the parsing progress (to include namespaces declared on the current element being parsed.)

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface XmlVisitor

Throws:

org.xml.sax.SAXException

startElement

public void startElement(TagName tagName)
                  throws org.xml.sax.SAXException

Description copied from interface: XmlVisitor

Notifies a start tag of a new element. namespace URIs and local names must be interned.

Specified by:

startElement in interface XmlVisitor

Throws:

org.xml.sax.SAXException

endElement

public void endElement(TagName tagName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface XmlVisitor

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String nsUri)
                        throws org.xml.sax.SAXException

Description copied from interface: XmlVisitor

Called before XmlVisitor.startElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName) event to notify a new namespace binding.

Specified by:

startPrefixMapping in interface XmlVisitor

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Description copied from interface: XmlVisitor

Called after XmlVisitor.endElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName) event to notify the end of a binding.

Specified by:

endPrefixMapping in interface XmlVisitor

Throws:

org.xml.sax.SAXException

text

public void text(java.lang.CharSequence pcdata)
          throws org.xml.sax.SAXException

Description copied from interface: XmlVisitor

Text events.

The caller should consult XmlVisitor.TextPredictor to see if the unmarshaller is expecting any PCDATA. If the above is returning false, the caller is OK to skip any text in XML. The net effect is that we can ignore whitespaces quickly.

Specified by:

text in interface XmlVisitor

Parameters:

pcdata - represents character data. This object can be mutable (such as StringBuilder); it only needs to be fixed while this method is executing.

Throws:

org.xml.sax.SAXException

getContext

public UnmarshallingContext getContext()

Description copied from interface: XmlVisitor

Returns the UnmarshallingContext at the end of the chain.

Specified by:

getContext in interface XmlVisitor

Returns:

always return the same object, so caching the result is recommended.

getPredictor

public XmlVisitor.TextPredictor getPredictor()

Description copied from interface: XmlVisitor

Gets the predictor that can be used for the caller to avoid calling XmlVisitor.text(CharSequence) unnecessarily.

Specified by:

getPredictor in interface XmlVisitor

expectText

@Deprecated
public boolean expectText()

Deprecated.

Description copied from interface: XmlVisitor.TextPredictor

Returns true if the visitor is expecting a text event as the next event.

This is primarily intended to be used for optimization to avoid buffering characters unnecessarily. If this method returns false and the connector sees whitespace it can safely skip it.

If this method returns true, all the whitespaces are considered significant and thus need to be reported as a XmlVisitor.text(java.lang.CharSequence) event. Furthermore, if the element has no children (like <foo/>), then it has to be reported an empty XmlVisitor.text(java.lang.CharSequence) event.

Specified by:

expectText in interface XmlVisitor.TextPredictor