Class UnmarshallingContext
- java.lang.Object
-
- org.glassfish.jaxb.runtime.v2.runtime.Coordinator
-
- org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.UnmarshallingContext
-
- All Implemented Interfaces:
jakarta.xml.bind.ValidationEventHandler,NamespaceContext,XmlVisitor,XmlVisitor.TextPredictor,ErrorHandler
public final class UnmarshallingContext extends Coordinator implements NamespaceContext, jakarta.xml.bind.ValidationEventHandler, ErrorHandler, XmlVisitor, XmlVisitor.TextPredictor
Center of the unmarshalling.This object is responsible for coordinating
Loaders to perform the whole unmarshalling.- Author:
- Kohsuke Kawaguchi
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classUnmarshallingContext.StateState information for each element.-
Nested classes/interfaces inherited from interface org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.XmlVisitor
XmlVisitor.TextPredictor
-
-
Field Summary
Fields Modifier and Type Field Description ClassLoaderclassLoaderUser-suppliedClassLoaderfor converting name toClass.ClassResolverclassResolverUsed to discover additional classes when we hit unknown elements/types.UnmarshallerImplparent
-
Constructor Summary
Constructors Constructor Description UnmarshallingContext(UnmarshallerImpl _parent, AssociationMap assoc)Creates a new unmarshaller.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddPatcher(Patcher job)Adds a job that will be executed at the last of the unmarshalling.StringaddToIdTable(String id)Adds the object which is currently being unmarshalled to the ID table.voidclearStates()ObjectcreateInstance(Class<?> clazz)Creates a new instance of the specified class.ObjectcreateInstance(JaxBeanInfo beanInfo)Creates a new instance of the specified class.voidendDocument()voidendElement(TagName tagName)voidendPrefixMapping(String prefix)Called afterXmlVisitor.endElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName)event to notify the end of a binding.voidendScope(int frameSize)Ends the current packing scope.voiderrorUnresolvedIDREF(Object bean, String idref, LocatorEx loc)Called when there's no corresponding ID value.booleanexpectText()Deprecated.String[]getAllDeclaredPrefixes()Returns a list of all in-scope prefixes.UnmarshallingContextgetContext()Returns theUnmarshallingContextat the end of the chain.Collection<QName>getCurrentExpectedAttributes()Allows to access attributes which are expected in current state.Collection<QName>getCurrentExpectedElements()Allows to access elements which are expected in current state.UnmarshallingContext.StategetCurrentState()ObjectgetInnerPeer()Gets the inner peer JAXB object associated with the current element.static UnmarshallingContextgetInstance()When called from within the realm of the unmarshaller, this method returns the currentUnmarshallingContextin charge.JAXBContextImplgetJAXBContext()protected jakarta.xml.bind.ValidationEventLocatorgetLocation()Gets the current location.LocatorExgetLocator()Gets the current source location information in SAXLocator.StringgetNamespaceURI(String prefix)String[]getNewlyDeclaredPrefixes()Returns a list of prefixes newly declared on the current element.CallablegetObjectFromId(String id, Class targetType)Looks up the ID table and gets associated object.ObjectgetOuterPeer()Gets the outer peer JAXB object associated with the current element.XmlVisitor.TextPredictorgetPredictor()Deprecated.StringgetPrefix(String uri)Iterator<String>getPrefixes(String uri)ObjectgetResult()Gets the result of the unmarshallingScopegetScope(int offset)Gets the currently activeScope.StructureLoadergetStructureLoader()Gets StructureLoader if used as loader.StringgetXMIMEContentType()Gets the xmime:contentType value for the current object.voidhandleError(Exception e)Reports an exception found during the unmarshalling to the user.voidhandleError(Exception e, boolean canRecover)voidhandleError(String msg)booleanhandleEvent(jakarta.xml.bind.ValidationEvent event)voidhandleEvent(jakarta.xml.bind.ValidationEvent event, boolean canRecover)Reports an error to the user, and asks if s/he wants to recover.voidrecordInnerPeer(Object innerPeer)Notifies the context about the inner peer of the current element.voidrecordOuterPeer(Object outerPeer)Notifies the context about the outer peer of the current element.voidreset(InfosetScanner scanner, boolean isInplaceMode, JaxBeanInfo expectedType, IDResolver idResolver)LoaderselectRootLoader(UnmarshallingContext.State state, TagName tag)On top ofJAXBContextImpl.selectRootLoader(State, TagName), this method also consultsClassResolver.voidsetFactories(Object factoryInstances)booleanshouldErrorBeReported()voidstartDocument(LocatorEx locator, NamespaceContext nsContext)Notifies a start of the document.voidstartElement(TagName tagName)Notifies a start tag of a new element.voidstartPrefixMapping(String prefix, String uri)Called beforeXmlVisitor.startElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName)event to notify a new namespace binding.voidstartScope(int frameSize)Starts a new packing scope.voidtext(CharSequence pcdata)Text events.-
Methods inherited from class org.glassfish.jaxb.runtime.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 Detail
-
parent
public final UnmarshallerImpl parent
-
classResolver
@Nullable public ClassResolver classResolver
Used to discover additional classes when we hit unknown elements/types.
-
classLoader
@Nullable public ClassLoader classLoader
User-suppliedClassLoaderfor converting name toClass. For backward compatibility, when null, use thread context classloader.
-
-
Constructor Detail
-
UnmarshallingContext
public UnmarshallingContext(UnmarshallerImpl _parent, AssociationMap assoc)
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 Detail
-
reset
public void reset(InfosetScanner scanner, boolean isInplaceMode, JaxBeanInfo expectedType, IDResolver idResolver)
-
getJAXBContext
public JAXBContextImpl getJAXBContext()
-
getCurrentState
public UnmarshallingContext.State getCurrentState()
-
selectRootLoader
public Loader selectRootLoader(UnmarshallingContext.State state, TagName tag) throws SAXException
On top ofJAXBContextImpl.selectRootLoader(State, TagName), this method also consultsClassResolver.- Throws:
SAXException- ifValidationEventHandlerreported a failure.
-
clearStates
public void clearStates()
-
setFactories
public void setFactories(Object factoryInstances)
-
startDocument
public void startDocument(LocatorEx locator, NamespaceContext nsContext) throws SAXException
Description copied from interface:XmlVisitorNotifies a start of the document.- Specified by:
startDocumentin 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 additionalNamespaceContextobject 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
public void startElement(TagName tagName) throws SAXException
Description copied from interface:XmlVisitorNotifies a start tag of a new element. namespace URIs and local names must be interned.- Specified by:
startElementin interfaceXmlVisitor- Throws:
SAXException
-
text
public void text(CharSequence pcdata) throws SAXException
Description copied from interface:XmlVisitorText events.The caller should consult
XmlVisitor.TextPredictorto 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:
textin 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
public final void endElement(TagName tagName) throws SAXException
- Specified by:
endElementin interfaceXmlVisitor- Throws:
SAXException
-
endDocument
public void endDocument() throws SAXException- Specified by:
endDocumentin interfaceXmlVisitor- Throws:
SAXException
-
expectText
@Deprecated public boolean expectText()
Deprecated.You should be always calling this throughXmlVisitor.TextPredictor.- Specified by:
expectTextin interfaceXmlVisitor.TextPredictor
-
getPredictor
@Deprecated public XmlVisitor.TextPredictor getPredictor()
Deprecated.You should be always gettingXmlVisitor.TextPredictorfromXmlVisitor.- Specified by:
getPredictorin interfaceXmlVisitor
-
getContext
public UnmarshallingContext getContext()
Description copied from interface:XmlVisitorReturns theUnmarshallingContextat the end of the chain.- Specified by:
getContextin interfaceXmlVisitor- Returns:
- always return the same object, so caching the result is recommended.
-
getResult
public Object getResult() throws jakarta.xml.bind.UnmarshalException
Gets the result of the unmarshalling- Throws:
jakarta.xml.bind.UnmarshalException
-
createInstance
public Object createInstance(Class<?> clazz) throws SAXException
Creates a new instance of the specified class. In the unmarshaller, we need to check the user-specified factory class.- Throws:
SAXException
-
createInstance
public Object createInstance(JaxBeanInfo beanInfo) throws SAXException
Creates a new instance of the specified class. In the unmarshaller, we need to check the user-specified factory class.- Throws:
SAXException
-
handleEvent
public void handleEvent(jakarta.xml.bind.ValidationEvent event, boolean canRecover) throws SAXExceptionReports 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
public boolean handleEvent(jakarta.xml.bind.ValidationEvent event)
- Specified by:
handleEventin interfacejakarta.xml.bind.ValidationEventHandler
-
handleError
public void handleError(Exception e) throws SAXException
Reports an exception found during the unmarshalling to the user. This method is a convenience method that calls intohandleEvent(ValidationEvent, boolean)- Throws:
SAXException
-
handleError
public void handleError(Exception e, boolean canRecover) throws SAXException
- Throws:
SAXException
-
handleError
public void handleError(String msg)
-
getLocation
protected jakarta.xml.bind.ValidationEventLocator getLocation()
Description copied from class:CoordinatorGets the current location. Used for reporting the error source location.- Specified by:
getLocationin classCoordinator
-
getLocator
public LocatorEx 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
public void errorUnresolvedIDREF(Object bean, String idref, LocatorEx loc) throws SAXException
Called when there's no corresponding ID value.- Throws:
SAXException
-
addPatcher
public void addPatcher(Patcher job)
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
public String addToIdTable(String id) throws SAXException
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
public Callable getObjectFromId(String id, Class targetType) throws SAXException
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:
IDResolver.resolve(String, Class)
-
startPrefixMapping
public void startPrefixMapping(String prefix, String uri)
Description copied from interface:XmlVisitorCalled beforeXmlVisitor.startElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName)event to notify a new namespace binding.- Specified by:
startPrefixMappingin interfaceXmlVisitor
-
endPrefixMapping
public void endPrefixMapping(String prefix)
Description copied from interface:XmlVisitorCalled afterXmlVisitor.endElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName)event to notify the end of a binding.- Specified by:
endPrefixMappingin interfaceXmlVisitor
-
getNewlyDeclaredPrefixes
public String[] 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
public 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
public Iterator<String> getPrefixes(String uri)
- Specified by:
getPrefixesin interfaceNamespaceContext
-
getPrefix
public String getPrefix(String uri)
- Specified by:
getPrefixin interfaceNamespaceContext
-
getNamespaceURI
public String getNamespaceURI(String prefix)
- Specified by:
getNamespaceURIin interfaceNamespaceContext
-
startScope
public void startScope(int frameSize)
Starts a new packing scope.This method allocates a specified number of fresh
Scopeobjects. 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
Scopes can be accessed at any given time.- Parameters:
frameSize- The # of slots to be allocated.
-
endScope
public void endScope(int frameSize) throws SAXExceptionEnds 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
public Scope getScope(int offset)
Gets the currently activeScope.- Parameters:
offset- a number between [0,frameSize)- Returns:
- always a valid
Scopeobject.
-
recordInnerPeer
public void recordInnerPeer(Object innerPeer)
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
public Object 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
public void recordOuterPeer(Object outerPeer)
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
public Object 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
public String getXMIMEContentType()
Gets the xmime:contentType value for the current object.
-
getInstance
public static UnmarshallingContext getInstance()
When called from within the realm of the unmarshaller, this method returns the currentUnmarshallingContextin charge.
-
getCurrentExpectedElements
public Collection<QName> getCurrentExpectedElements()
Allows to access elements which are expected in current state. Useful for getting elements for current parent.- Returns:
-
getCurrentExpectedAttributes
public Collection<QName> getCurrentExpectedAttributes()
Allows to access attributes which are expected in current state. Useful for getting attributes for current parent.- Returns:
-
getStructureLoader
public StructureLoader getStructureLoader()
Gets StructureLoader if used as loader. Useful when determining if element is mixed or not.
-
shouldErrorBeReported
public boolean shouldErrorBeReported() throws SAXExceptionBased on currentLoggerLeveland 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.FINESTis set OR we haven't exceed errors reporting limit. - Throws:
SAXException
-
-