JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.runtime.Coordinator

Object that coordinates the marshalling/unmarshalling.

This class takes care of the logic that allows code to obtain UnmarshallingContext and XMLSerializer instances during the unmarshalling/marshalling.

This is done by using a ThreadLocal. Therefore one unmarshalling/marshalling episode has to be done from the beginning till end by the same thread. (Note that the same Coordinator can be then used by a different thread for an entirely different episode.) This class also maintains the user-configured instances of XmlAdapters.

This class implements ErrorHandler and propages erros to this object as the ValidationEventHandler, which will be implemented in a derived class.

Field Summary

Modifier and Type	Field and Description
private static final ThreadLocal<Coordinator>	activeTable
private final HashMap<Class<? extends XmlAdapter<ValueType, BoundType>>, XmlAdapter<ValueType, BoundType>>	adapters
private Coordinator	old The `Coordinator` in charge before this `Coordinator`.

Constructor Summary

Access	Constructor and Description
protected	Coordinator() Default constructor.

Method Summary

Modifier and Type	Method and Description
public static Coordinator	_getInstance()
public <T extends XmlAdapter<ValueType, BoundType>> boolean	containsAdapter(Class<T> type)
public final void	error(SAXParseException exception) Implements org.xml.sax.ErrorHandler.error. Receive notification of a recoverable error.
public final void	fatalError(SAXParseException exception) Implements org.xml.sax.ErrorHandler.fatalError. Receive notification of a non-recoverable, fatal error.
public final <T extends XmlAdapter<ValueType, BoundType>> T	Returns: always non-null. getAdapter(Class<T> key) Gets the instance of the adapter.
protected abstract ValidationEventLocator	getLocation() Gets the current location.
protected final void	popCoordinator() Called whenever an execution flow exits the realm of this .
private void	propagateEvent(int severity, SAXParseException saxException)
protected final void	pushCoordinator() Called whenever an execution flow enters the realm of this .
public final XmlAdapter<ValueType, BoundType>	putAdapter(Class<? extends XmlAdapter<ValueType, BoundType>> c, XmlAdapter<ValueType, BoundType> a)
public final void	warning(SAXParseException exception) Implements org.xml.sax.ErrorHandler.warning. Receive notification of a warning.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

activeTable	back to summary
private static final ThreadLocal<Coordinator> activeTable

adapters	back to summary
private final HashMap<Class<? extends XmlAdapter<ValueType, BoundType>>, XmlAdapter<ValueType, BoundType>> adapters

old	back to summary
private Coordinator old The `Coordinator` in charge before this `Coordinator`.

Constructor Detail

Coordinator	back to summary
protected Coordinator() Default constructor.

Method Detail

_getInstance	back to summary
public static Coordinator _getInstance()

containsAdapter	back to summary
public <T extends XmlAdapter<ValueType, BoundType>> boolean containsAdapter(Class<T> type)

error	back to summary
public final void error(SAXParseException exception) throws SAXException Implements org.xml.sax.ErrorHandler.error. Doc from org.xml.sax.ErrorHandler.error. Receive notification of a recoverable error. This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so. Filters may use this method to report other, non-XML errors as well. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

error

back to summary

public final void error(SAXParseException exception) throws SAXException

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

fatalError	back to summary
public final void fatalError(SAXParseException exception) throws SAXException Implements org.xml.sax.ErrorHandler.fatalError. Doc from org.xml.sax.ErrorHandler.fatalError. Receive notification of a non-recoverable, fatal error. As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation. Annotations @Override Exceptions SAXException: if the application chooses to discontinue the parsing

fatalError

back to summary

public final void fatalError(SAXParseException exception) throws SAXException

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Annotations

@Override

Exceptions

SAXException:: if the application chooses to discontinue the parsing

getAdapter	back to summary
public final <T extends XmlAdapter<ValueType, BoundType>> T getAdapter(Class<T> key) Gets the instance of the adapter. Returns:T always non-null.

getAdapter

back to summary

public final <T extends XmlAdapter<ValueType, BoundType>> T getAdapter(Class<T> key)

Gets the instance of the adapter.

Returns:T: always non-null.

getLocation	back to summary
protected abstract ValidationEventLocator getLocation() Gets the current location. Used for reporting the error source location.

popCoordinator	back to summary
protected final void popCoordinator() Called whenever an execution flow exits the realm of this .

propagateEvent	back to summary
private void propagateEvent(int severity, SAXParseException saxException) throws SAXException

pushCoordinator	back to summary
protected final void pushCoordinator() Called whenever an execution flow enters the realm of this .

putAdapter	back to summary
public final XmlAdapter<ValueType, BoundType> putAdapter(Class<? extends XmlAdapter<ValueType, BoundType>> c, XmlAdapter<ValueType, BoundType> a)

warning	back to summary
public final void warning(SAXParseException exception) throws SAXException Implements org.xml.sax.ErrorHandler.warning. Doc from org.xml.sax.ErrorHandler.warning. Receive notification of a warning. SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. Filters may use this method to report other, non-XML warnings as well. Annotations @Override Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

warning

back to summary

public final void warning(SAXParseException exception) throws SAXException

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

public abstract Class Coordinator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail