Class XmlStringLookup

java.lang.Object

org.apache.commons.text.lookup.AbstractStringLookup

org.apache.commons.text.lookup.AbstractPathFencedLookup

org.apache.commons.text.lookup.XmlStringLookup

All Implemented Interfaces:

Function<String,String>, UnaryOperator<String>, StringLookup

final class XmlStringLookup
extends AbstractPathFencedLookup

Looks up values in an XML document in the format "DocumentPath:XPath".

For example:

• "com/domain/document.xml:/path/to/node"

Secure processing is enabled by default and can be overridden with StringLookupFactory.xmlStringLookup(Map, Path...).

Since:

1.5

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Map<String,Boolean>	DEFAULT_XML_FEATURES	Defines default XML factory features.
(package private) static final Map<String,Boolean>	DEFAULT_XPATH_FEATURES	Defines default XPath factory features.
(package private) static final XmlStringLookup	INSTANCE	Defines the singleton for this class with secure processing enabled by default.
private static final int	KEY_PARTS_LEN	The number of key parts.
private final Map<String,Boolean>	xmlFactoryFeatures	Defines XML factory features.
private final Map<String,Boolean>	xPathFactoryFeatures	Defines XPath factory features.

Fields inherited from class AbstractPathFencedLookup

fence

Fields inherited from class AbstractStringLookup

SPLIT_CH, SPLIT_STR

Constructor Summary

Constructors

Constructor	Description
XmlStringLookup(Map<String,Boolean> xmlFactoryFeatures, Map<String,Boolean> xPathFactoryFeatures, Path... fences)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
String	lookup(String key)	Looks up a value for the key in the format "DocumentPath:XPath".

Methods inherited from class AbstractPathFencedLookup

getPath

Methods inherited from class AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class Object

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

Methods inherited from interface Function

andThen, compose

Methods inherited from interface StringLookup

apply

Field Details

KEY_PARTS_LEN

private static final int KEY_PARTS_LEN

The number of key parts.

See Also:

• Constant Field Values

DEFAULT_XPATH_FEATURES

static final Map<String,Boolean> DEFAULT_XPATH_FEATURES

Defines default XPath factory features.

DEFAULT_XML_FEATURES

static final Map<String,Boolean> DEFAULT_XML_FEATURES

Defines default XML factory features.

INSTANCE

static final XmlStringLookup INSTANCE

Defines the singleton for this class with secure processing enabled by default.

Secure processing is enabled by default and can be overridden with StringLookupFactory.xmlStringLookup(Map, Path...).

xPathFactoryFeatures

private final Map<String,Boolean> xPathFactoryFeatures

Defines XPath factory features.

xmlFactoryFeatures

private final Map<String,Boolean> xmlFactoryFeatures

Defines XML factory features.

Constructor Details

XmlStringLookup

XmlStringLookup(Map<String,Boolean> xmlFactoryFeatures,
 Map<String,Boolean> xPathFactoryFeatures,
 Path... fences)

Constructs a new instance.

Parameters:

xmlFactoryFeatures - The DocumentBuilderFactory features to set.

xPathFactoryFeatures - The XPathFactory features to set.

See Also:

• DocumentBuilderFactory.setFeature(String, boolean)
• XPathFactory.setFeature(String, boolean)

Method Details

lookup

public String lookup(String key)

Looks up a value for the key in the format "DocumentPath:XPath".

For example:

• "com/domain/document.xml:/path/to/node"

Secure processing is enabled by default and can be overridden with StringLookupFactory.xmlStringLookup(Map, Path...).

Parameters:

key - the key to be looked up, may be null.

Returns:

The value associated with the key.