org.xmlfield.core

Class XmlFieldFactory

java.lang.Object

org.xmlfield.core.XmlFieldFactory

public class XmlFieldFactory
extends Object

Factory used to create XmlField instances.

This factory is thread safe and can be configured to use ThreadLocal to reuse XmlField instances for performance reasons.

When using ThreadLocal, configuration ( parserConfiguration and getter cache) is unique (static) across all XmlFieldFactory instances.

Author:

Nicolas Richeton

See Also:

CleanThreadLocalFilter

Constructor Summary

Constructors

Constructor and Description
XmlFieldFactory()
XmlFieldFactory(boolean useThreadLocal)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanThreadLocal() Clean the XmlField instance of the current thread.
XmlField	getXmlField() Get a new XmlField instance, or the instance associated with the current thread if #setUseThreadLocal(boolean) is enabled.
void	setGetterCache(boolean enabled) Enable Getter cache.
void	setParserConfiguration(Map<String,String> configuration) Set parser configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlFieldFactory

public XmlFieldFactory()

XmlFieldFactory

public XmlFieldFactory(boolean useThreadLocal)

Parameters:

useThreadLocal - When enabled, the factory will create only one XmlField object per thread and reuse it each time getXmlField() is called.

This improves performance if getXmlField() is called several times in the same thread. But it is still better to keep the XmlField object and reuse it because it it not subject to synchronization.

When used in a web application, it is recommended to use a servlet filter which clears the context after each call to prevent leaks in application servers.

See Also:

CleanThreadLocalFilter

Method Detail

cleanThreadLocal

public void cleanThreadLocal()

Clean the XmlField instance of the current thread.

getXmlField

public XmlField getXmlField()

Get a new XmlField instance, or the instance associated with the current thread if #setUseThreadLocal(boolean) is enabled.

Returns:

setGetterCache

public void setGetterCache(boolean enabled)

Enable Getter cache.

Parameters:

enabled -

See Also:

XmlField.setGetterCache(boolean)

setParserConfiguration

public void setParserConfiguration(Map<String,String> configuration)

Set parser configuration. All XmlField instances will use this configuration.

Parameters:

configuration -