Package org.glassfish.jaxb.runtime.v2.runtime.unmarshaller

Class UnmarshallingContext

java.lang.Object
org.glassfish.jaxb.runtime.v2.runtime.Coordinator
org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.UnmarshallingContext
All Implemented Interfaces:
ValidationEventHandler, NamespaceContext, XmlVisitor, XmlVisitor.TextPredictor, ErrorHandler
public final class UnmarshallingContext extends Coordinator implements NamespaceContext, ValidationEventHandler, ErrorHandler, XmlVisitor, XmlVisitor.TextPredictor
Center of the unmarshalling.

This object is responsible for coordinating Loaders to perform the whole unmarshalling.

Author:
Kohsuke Kawaguchi

  • Field Details

  • Constructor Details

    • 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 Details

    • 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 of JAXBContextImpl.selectRootLoader(State, TagName), this method also consults ClassResolver.
      Throws:
      SAXException - if ValidationEventHandler reported 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: 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:
      SAXException

    • startElement

      public void startElement(TagName tagName) throws 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:
      SAXException

    • text

      public void text(CharSequence pcdata) throws 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:
      SAXException

    • endElement

      public void endElement(TagName tagName) throws SAXException
      Specified by:
      endElement in interface XmlVisitor
      Throws:
      SAXException

    • endDocument

      public void endDocument() throws SAXException
      Specified by:
      endDocument in interface XmlVisitor
      Throws:
      SAXException

    • expectText

      @Deprecated public boolean expectText()
      Deprecated.
      You should be always calling this through XmlVisitor.TextPredictor.
      Specified by:
      expectText in interface XmlVisitor.TextPredictor

    • getPredictor

      @Deprecated public XmlVisitor.TextPredictor getPredictor()
      Deprecated.
      You should be always getting XmlVisitor.TextPredictor from XmlVisitor.
      Specified by:
      getPredictor in interface XmlVisitor

    • 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.

    • getResult

      public Object getResult() throws UnmarshalException
      Gets the result of the unmarshalling
      Throws:
      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(ValidationEvent event, boolean canRecover) throws SAXException
      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

      public boolean handleEvent(ValidationEvent event)
      Description copied from interface: ValidationEventHandler
      Receive notification of a validation warning or error.

      The ValidationEvent will have a ValidationEventLocator embedded in it that indicates where the error or warning occurred.

      If an unchecked runtime exception is thrown from this method, the Jakarta XML Binding provider will treat it as if the method returned false and interrupt the current unmarshal, validate, or marshal operation.

      Specified by:
      handleEvent in interface ValidationEventHandler
      Parameters:
      event - the encapsulated validation event information. It is a provider error if this parameter is null.
      Returns:
      true if the Jakarta XML Binding Provider should attempt to continue the current unmarshal, validate, or marshal operation after handling this warning/error, false if the provider should terminate the current operation with the appropriate UnmarshalException, ValidationException, or MarshalException.

    • 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 into handleEvent(ValidationEvent, boolean)
      Throws:
      SAXException

    • handleError

      public void handleError(Exception e, boolean canRecover) throws SAXException
      Throws:
      SAXException

    • handleError

      public void handleError(String msg)

    • getLocation

      protected ValidationEventLocator getLocation()
      Description copied from class: Coordinator
      Gets the current location. Used for reporting the error source location.
      Specified by:
      getLocation in class Coordinator

    • getLocator

      public LocatorEx getLocator()
      Gets the current source location information in SAX Locator.

      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:

    • startPrefixMapping

      public void startPrefixMapping(String prefix, String uri)
      Description copied from interface: XmlVisitor
      Called before XmlVisitor.startElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName) event to notify a new namespace binding.
      Specified by:
      startPrefixMapping in interface XmlVisitor

    • endPrefixMapping

      public void endPrefixMapping(String prefix)
      Description copied from interface: XmlVisitor
      Called after XmlVisitor.endElement(org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.TagName) event to notify the end of a binding.
      Specified by:
      endPrefixMapping in interface XmlVisitor

    • 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:
      getPrefixes in interface NamespaceContext

    • getPrefix

      public String getPrefix(String uri)
      Specified by:
      getPrefix in interface NamespaceContext

    • getNamespaceURI

      public String getNamespaceURI(String prefix)
      Specified by:
      getNamespaceURI in interface NamespaceContext

    • 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 the getScope(int) method until the corresponding endScope(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 SAXException
      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 the startScope(int) method.
      Throws:
      SAXException

    • getScope

      public Scope getScope(int offset)
      Gets the currently active Scope.
      Parameters:
      offset - a number between [0,frameSize)
      Returns:
      always a valid Scope object.

    • 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.
      See Also:

    • getInstance

      public static UnmarshallingContext getInstance()
      When called from within the realm of the unmarshaller, this method returns the current in charge.

    • getCurrentExpectedElements

      public Collection<QName> getCurrentExpectedElements()
      Allows to access elements which are expected in current state. Useful for getting elements for current parent.

    • getCurrentExpectedAttributes

      public Collection<QName> getCurrentExpectedAttributes()
      Allows to access attributes which are expected in current state. Useful for getting attributes for current parent.

    • getStructureLoader

      public StructureLoader getStructureLoader()
      Gets StructureLoader if used as loader. Useful when determining if element is mixed or not.

    • shouldErrorBeReported

      public boolean shouldErrorBeReported() throws SAXException
      Based on current Logger 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