com.haulmont.cuba.core.sys.xmlparsing

Class Dom4jTools

java.lang.Object

com.haulmont.cuba.core.sys.xmlparsing.Dom4jTools

@Component(value="cuba_Dom4jTools")
public class Dom4jTools
extends java.lang.Object

Helper bean for XML parsing. Caches SAXParser instances in the pool. Pool size and timeout to borrow can be configured with the application properties cuba.dom4j.maxPoolSize and cuba.dom4j.maxBorrowWaitMillis

Field Summary

Fields

Modifier and Type	Field and Description
protected Dom4jToolsConfig	config
protected GlobalConfig	globalConfig
static java.lang.String	NAME
protected org.apache.commons.pool2.impl.GenericObjectPool<javax.xml.parsers.SAXParser>	pool

Constructor Summary

Constructors

Constructor and Description
Dom4jTools(GlobalConfig globalConfig, Dom4jToolsConfig config) INTERNAL

Method Summary

Modifier and Type	Method and Description
protected org.dom4j.io.SAXReader	getSaxReader(javax.xml.parsers.SAXParser saxParser)
protected void	initPool()
void	loadMap(org.dom4j.Element mapElement, java.util.Map<java.lang.String,java.lang.String> map)
org.dom4j.Document	readDocument(java.io.File file)
org.dom4j.Document	readDocument(java.io.InputStream stream)
org.dom4j.Document	readDocument(java.io.Reader reader)
org.dom4j.Document	readDocument(java.lang.String xmlString)
void	shutdown() Shuts down the pool, unregisters JMX.
void	storeMap(org.dom4j.Element parentElement, java.util.Map<java.lang.String,java.lang.String> map)
void	walkAttributes(org.dom4j.Element element, Dom4j.ElementAttributeVisitor visitor)
void	walkAttributesRecursive(org.dom4j.Element element, Dom4j.ElementAttributeVisitor visitor)
protected <T> T	withSAXParserFromPool(java.util.function.Function<javax.xml.parsers.SAXParser,T> action)
java.lang.String	writeDocument(org.dom4j.Document doc, boolean prettyPrint)
void	writeDocument(org.dom4j.Document doc, boolean prettyPrint, java.io.OutputStream stream)
void	writeDocument(org.dom4j.Document doc, boolean prettyPrint, java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

config

protected Dom4jToolsConfig config

globalConfig

protected GlobalConfig globalConfig

pool

protected org.apache.commons.pool2.impl.GenericObjectPool<javax.xml.parsers.SAXParser> pool

Constructor Detail

Dom4jTools

@Inject
public Dom4jTools(GlobalConfig globalConfig,
                          Dom4jToolsConfig config)

INTERNAL

Method Detail

initPool

protected void initPool()

shutdown

public void shutdown()

Shuts down the pool, unregisters JMX.

writeDocument

public java.lang.String writeDocument(org.dom4j.Document doc,
                                      boolean prettyPrint)

writeDocument

public void writeDocument(org.dom4j.Document doc,
                          boolean prettyPrint,
                          java.io.Writer writer)

writeDocument

public void writeDocument(org.dom4j.Document doc,
                          boolean prettyPrint,
                          java.io.OutputStream stream)

readDocument

public org.dom4j.Document readDocument(java.io.File file)

readDocument

public org.dom4j.Document readDocument(java.io.InputStream stream)

readDocument

public org.dom4j.Document readDocument(java.io.Reader reader)

readDocument

public org.dom4j.Document readDocument(java.lang.String xmlString)

storeMap

public void storeMap(org.dom4j.Element parentElement,
                     java.util.Map<java.lang.String,java.lang.String> map)

loadMap

public void loadMap(org.dom4j.Element mapElement,
                    java.util.Map<java.lang.String,java.lang.String> map)

walkAttributesRecursive

public void walkAttributesRecursive(org.dom4j.Element element,
                                    Dom4j.ElementAttributeVisitor visitor)

walkAttributes

public void walkAttributes(org.dom4j.Element element,
                           Dom4j.ElementAttributeVisitor visitor)

getSaxReader

protected org.dom4j.io.SAXReader getSaxReader(javax.xml.parsers.SAXParser saxParser)

withSAXParserFromPool

protected <T> T withSAXParserFromPool(java.util.function.Function<javax.xml.parsers.SAXParser,T> action)