Package org.apache.sis.xml

Class PooledTemplate

java.lang.Object

org.apache.sis.xml.Pooled

org.apache.sis.xml.PooledTemplate

final class PooledTemplate
extends Pooled

The template to use for PooledMarshaller and PooledUnmarshaller initialization. We use this class for parsing XML property values from the map given by the user right at MarshallerPool construction time. This allow both to catch errors sooner, and avoid redoing the conversion every time a new (un)marshaller is requested.

Since:

0.3

Version:

0.3

Field Summary

Fields inherited from class org.apache.sis.xml.Pooled

initialProperties, resetTime

Constructor Summary

Constructors

Constructor	Description
PooledTemplate(Map<String,?> properties, Implementation implementation)	Creates a new template.

Method Summary

Modifier and Type	Method	Description
<A extends XmlAdapter> A	getAdapter(Class<A> type)	Should never be invoked on PooledTemplate instances.
ValidationEventHandler	getEventHandler()	Should never be invoked on PooledTemplate instances.
Schema	getSchema()	Should never be invoked on PooledTemplate instances.
(package private) Object	getStandardProperty(String name)	Indirectly invoked by the constructor as a side-effect of Pooled.setProperty(String, Object) implementation in the super-class This method is not of interest to PooledTemplate.
(package private) String	remove(String name, String defaultValue)	Remove the given value from the Pooled.initialProperties map.
protected void	reset(Object key, Object value)	Should never be invoked on PooledTemplate instances.
(package private) void	setStandardProperty(String name, Object value)	Indirectly invoked by the constructor (through the Pooled.setProperty(String, Object) method) for storing a property which is not one of the properties defined in the XML class.

Methods inherited from class org.apache.sis.xml.Pooled

begin, getProperty, getRootAdapters, getTransformVersion, initialize, isPropertySaved, reset, saveProperty, setAdapter, setAdapter, setEventHandler, setProperty, setSchema, specificBitMasks

Methods inherited from class java.lang.Object

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

Constructor Details

PooledTemplate

PooledTemplate(Map<String,?> properties,
 Implementation implementation)
        throws PropertyException

Creates a new template.

Parameters:

properties - the properties to be given to JAXB (un)marshallers, or null if none.

implementation - Implementation.INTERNAL if the JAXB implementation is the one bundled in JDK 6, or Implementation.ENDORSED if this is the external implementation provided as a JAR file in the endorsed directory.

Throws:

PropertyException

Method Details

setStandardProperty

void setStandardProperty(String name,
 Object value)

Indirectly invoked by the constructor (through the Pooled.setProperty(String, Object) method) for storing a property which is not one of the properties defined in the XML class. This method overwrites the values stored by the super-class, which are only null because getStandardProperty(String) is implemented that way.

Specified by:

setStandardProperty in class Pooled

getStandardProperty

Object getStandardProperty(String name)

Indirectly invoked by the constructor as a side-effect of Pooled.setProperty(String, Object) implementation in the super-class This method is not of interest to PooledTemplate. However, as a safety, the above setStandardProperty(String, Object) method will check that the map contains the value returned here.

Specified by:

getStandardProperty in class Pooled

remove

String remove(String name,
 String defaultValue)
       throws PropertyException

Remove the given value from the Pooled.initialProperties map. This method is used for values that are handled especially by the MarshallerPool constructor.

Current implementation expects values of type String, but this may be generalized in a future SIS version if there is a need for that.

Parameters:

name - the name of the property to remove.

defaultValue - the default value to return if the given property is not defined in the map.

Returns:

the old value of that property, or defaultValue if the given property was not defined.

Throws:

PropertyException - if the given property is not of the expected type.

reset

protected void reset(Object key,
 Object value)

Should never be invoked on PooledTemplate instances.

Specified by:

reset in class Pooled

Parameters:

key - the property to reset.

value - the initial value to give to the property.

getAdapter

public <A extends XmlAdapter> A getAdapter(Class<A> type)

Should never be invoked on PooledTemplate instances.

Specified by:

getAdapter in class Pooled

getSchema

public Schema getSchema()

Should never be invoked on PooledTemplate instances.

Specified by:

getSchema in class Pooled

getEventHandler

public ValidationEventHandler getEventHandler()

Should never be invoked on PooledTemplate instances.

Specified by:

getEventHandler in class Pooled