Class UnmarshallingContext
- All Implemented Interfaces:
XmlVisitor
,XmlVisitor.TextPredictor
,ValidationEventHandler
,NamespaceContext
,ErrorHandler
This object is responsible for coordinating Loader
s to
perform the whole unmarshalling.
- Author:
- Kohsuke Kawaguchi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionfinal class
State information for each element.Nested classes/interfaces inherited from interface com.sun.xml.bind.v2.runtime.unmarshaller.XmlVisitor
XmlVisitor.TextPredictor
-
Field Summary
FieldsModifier and TypeFieldDescriptionUser-suppliedClassLoader
for converting name toClass
.Used to discover additional classes when we hit unknown elements/types.final UnmarshallerImpl
-
Constructor Summary
ConstructorsConstructorDescriptionUnmarshallingContext
(UnmarshallerImpl _parent, AssociationMap assoc) Creates a new unmarshaller. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPatcher
(Patcher job) Adds a job that will be executed at the last of the unmarshalling.addToIdTable
(String id) Adds the object which is currently being unmarshalled to the ID table.void
createInstance
(JaxBeanInfo beanInfo) Creates a new instance of the specified class.createInstance
(Class<?> clazz) Creates a new instance of the specified class.void
final void
endElement
(TagName tagName) void
endPrefixMapping
(String prefix) Called afterXmlVisitor.endElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName)
event to notify the end of a binding.void
endScope
(int frameSize) Ends the current packing scope.void
errorUnresolvedIDREF
(Object bean, String idref, LocatorEx loc) Called when there's no corresponding ID value.boolean
Deprecated.String[]
Returns a list of all in-scope prefixes.Returns theUnmarshallingContext
at the end of the chain.Allows to access attributes which are expected in current state.Allows to access elements which are expected in current state.Gets the inner peer JAXB object associated with the current element.static UnmarshallingContext
When called from within the realm of the unmarshaller, this method returns the currentUnmarshallingContext
in charge.protected ValidationEventLocator
Gets the current location.Gets the current source location information in SAXLocator
.getNamespaceURI
(String prefix) String[]
Returns a list of prefixes newly declared on the current element.getObjectFromId
(String id, Class targetType) Looks up the ID table and gets associated object.Gets the outer peer JAXB object associated with the current element.Deprecated.getPrefixes
(String uri) Gets the result of the unmarshallinggetScope
(int offset) Gets the currently activeScope
.Gets StructureLoader if used as loader.Gets the xmime:contentType value for the current object.void
Reports an exception found during the unmarshalling to the user.void
handleError
(Exception e, boolean canRecover) void
handleError
(String msg) boolean
handleEvent
(ValidationEvent event) void
handleEvent
(ValidationEvent event, boolean canRecover) Reports an error to the user, and asks if s/he wants to recover.void
recordInnerPeer
(Object innerPeer) Notifies the context about the inner peer of the current element.void
recordOuterPeer
(Object outerPeer) Notifies the context about the outer peer of the current element.void
reset
(InfosetScanner scanner, boolean isInplaceMode, JaxBeanInfo expectedType, IDResolver idResolver) selectRootLoader
(UnmarshallingContext.State state, TagName tag) On top ofJAXBContextImpl.selectRootLoader(State, TagName)
, this method also consultsClassResolver
.void
setFactories
(Object factoryInstances) boolean
void
startDocument
(LocatorEx locator, NamespaceContext nsContext) Notifies a start of the document.void
startElement
(TagName tagName) Notifies a start tag of a new element.void
startPrefixMapping
(String prefix, String uri) Called beforeXmlVisitor.startElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName)
event to notify a new namespace binding.void
startScope
(int frameSize) Starts a new packing scope.void
text
(CharSequence pcdata) Text events.Methods inherited from class com.sun.xml.bind.v2.runtime.Coordinator
_getInstance, containsAdapter, error, fatalError, getAdapter, popCoordinator, pushCoordinator, putAdapter, warning
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.ErrorHandler
error, fatalError, warning
-
Field Details
-
parent
-
classResolver
Used to discover additional classes when we hit unknown elements/types. -
classLoader
User-suppliedClassLoader
for converting name toClass
. For backward compatibility, when null, use thread context classloader.
-
-
Constructor Details
-
UnmarshallingContext
Creates a new unmarshaller.- Parameters:
assoc
- Must be both non-null when the unmarshaller does the in-place unmarshalling. Otherwise must be both null.
-
-
Method Details
-
reset
public void reset(InfosetScanner scanner, boolean isInplaceMode, JaxBeanInfo expectedType, IDResolver idResolver) -
getJAXBContext
-
getCurrentState
-
selectRootLoader
On top ofJAXBContextImpl.selectRootLoader(State, TagName)
, this method also consultsClassResolver
.- Throws:
SAXException
- ifValidationEventHandler
reported a failure.
-
clearStates
public void clearStates() -
setFactories
-
startDocument
Description copied from interface:XmlVisitor
Notifies a start of the document.- Specified by:
startDocument
in interfaceXmlVisitor
- 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 emulateXmlVisitor.startPrefixMapping(String, String)
correctly when unmarshalling a subtree. Connectors that use such an API can pass in additionalNamespaceContext
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:
SAXException
-
startElement
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 interfaceXmlVisitor
- Throws:
SAXException
-
text
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 interfaceXmlVisitor
- Parameters:
pcdata
- represents character data. This object can be mutable (such asStringBuilder
); it only needs to be fixed while this method is executing.- Throws:
SAXException
-
endElement
- Specified by:
endElement
in interfaceXmlVisitor
- Throws:
SAXException
-
endDocument
- Specified by:
endDocument
in interfaceXmlVisitor
- Throws:
SAXException
-
expectText
Deprecated.You should be always calling this throughXmlVisitor.TextPredictor
.- Specified by:
expectText
in interfaceXmlVisitor.TextPredictor
-
getPredictor
Deprecated.You should be always gettingXmlVisitor.TextPredictor
fromXmlVisitor
.- Specified by:
getPredictor
in interfaceXmlVisitor
-
getContext
Description copied from interface:XmlVisitor
Returns theUnmarshallingContext
at the end of the chain.- Specified by:
getContext
in interfaceXmlVisitor
- Returns:
- always return the same object, so caching the result is recommended.
-
getResult
Gets the result of the unmarshalling- Throws:
UnmarshalException
-
createInstance
Creates a new instance of the specified class. In the unmarshaller, we need to check the user-specified factory class.- Throws:
SAXException
-
createInstance
Creates a new instance of the specified class. In the unmarshaller, we need to check the user-specified factory class.- Throws:
SAXException
-
handleEvent
Reports an error to the user, and asks if s/he wants to recover. If the canRecover flag is false, regardless of the client instruction, an exception will be thrown. Only if the flag is true and the user wants to recover from an error, the method returns normally. The thrown exception will be catched by the unmarshaller.- Throws:
SAXException
-
handleEvent
- Specified by:
handleEvent
in interfaceValidationEventHandler
-
handleError
Reports an exception found during the unmarshalling to the user. This method is a convenience method that calls intohandleEvent(ValidationEvent, boolean)
- Throws:
SAXException
-
handleError
- Throws:
SAXException
-
handleError
-
getLocation
Description copied from class:Coordinator
Gets the current location. Used for reporting the error source location.- Specified by:
getLocation
in classCoordinator
-
getLocator
Gets the current source location information in SAXLocator
.Sometimes the unmarshaller works against a different kind of XML source, making this information meaningless.
-
errorUnresolvedIDREF
Called when there's no corresponding ID value.- Throws:
SAXException
-
addPatcher
Adds a job that will be executed at the last of the unmarshalling. This method is used to support ID/IDREF feature, but it can be used for other purposes as well.- Parameters:
job
- The run method of this object is called.
-
addToIdTable
Adds the object which is currently being unmarshalled to the ID table.- Returns:
- Returns the value passed as the parameter. This is a hack, but this makes it easier for ID transducer to do its job.
- Throws:
SAXException
-
getObjectFromId
Looks up the ID table and gets associated object.The exception thrown from
Callable.call()
means the unmarshaller should abort right away.- Throws:
SAXException
- See Also:
-
startPrefixMapping
Description copied from interface:XmlVisitor
Called beforeXmlVisitor.startElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName)
event to notify a new namespace binding.- Specified by:
startPrefixMapping
in interfaceXmlVisitor
-
endPrefixMapping
Description copied from interface:XmlVisitor
Called afterXmlVisitor.endElement(com.sun.xml.bind.v2.runtime.unmarshaller.TagName)
event to notify the end of a binding.- Specified by:
endPrefixMapping
in interfaceXmlVisitor
-
getNewlyDeclaredPrefixes
Returns a list of prefixes newly declared on the current element.- Returns:
- A possible zero-length array of prefixes. The default prefix is represented by the empty string.
-
getAllDeclaredPrefixes
Returns a list of all in-scope prefixes.- Returns:
- A possible zero-length array of prefixes. The default prefix is represented by the empty string.
-
getPrefixes
- Specified by:
getPrefixes
in interfaceNamespaceContext
-
getPrefix
- Specified by:
getPrefix
in interfaceNamespaceContext
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceNamespaceContext
-
startScope
public void startScope(int frameSize) Starts a new packing scope.This method allocates a specified number of fresh
Scope
objects. They can be accessed by thegetScope(int)
method until the correspondingendScope(int)
method is invoked.A new scope will mask the currently active scope. Only one frame of
Scope
s can be accessed at any given time.- Parameters:
frameSize
- The # of slots to be allocated.
-
endScope
Ends the current packing scope.If any packing in progress will be finalized by this method.
- Parameters:
frameSize
- The same size that gets passed to thestartScope(int)
method.- Throws:
SAXException
-
getScope
Gets the currently activeScope
.- Parameters:
offset
- a number between [0,frameSize)- Returns:
- always a valid
Scope
object.
-
recordInnerPeer
Notifies the context about the inner peer of the current element.If the unmarshalling is building the association, the context will use this information. Otherwise it will be just ignored.
-
getInnerPeer
Gets the inner peer JAXB object associated with the current element.- Returns:
- null if the current element doesn't have an inner peer, or if we are not doing the in-place unmarshalling.
-
recordOuterPeer
Notifies the context about the outer peer of the current element.If the unmarshalling is building the association, the context will use this information. Otherwise it will be just ignored.
-
getOuterPeer
Gets the outer peer JAXB object associated with the current element.- Returns:
- null if the current element doesn't have an inner peer, or if we are not doing the in-place unmarshalling.
-
getXMIMEContentType
Gets the xmime:contentType value for the current object.- See Also:
-
getInstance
When called from within the realm of the unmarshaller, this method returns the currentUnmarshallingContext
in charge. -
getCurrentExpectedElements
Allows to access elements which are expected in current state. Useful for getting elements for current parent.- Returns:
-
getCurrentExpectedAttributes
Allows to access attributes which are expected in current state. Useful for getting attributes for current parent.- Returns:
-
getStructureLoader
Gets StructureLoader if used as loader. Useful when determining if element is mixed or not. -
shouldErrorBeReported
Based on currentLogger
Level
and errorCounter value determines if error should be reported. If the method called and return true it is expected that error will be reported. And that's why errorCounter is automatically decremented during the check. NOT THREAD SAFE!!! In case of heave concurrency access several additional errors could be reported. It's not expected to be the problem. Otherwise add synchronization here.- Returns:
- true in case if
Level.FINEST
is set OR we haven't exceed errors reporting limit. - Throws:
SAXException
-