Package org.apache.commons.text.lookup

Class PropertiesStringLookup

java.lang.Object

org.apache.commons.text.lookup.AbstractStringLookup

org.apache.commons.text.lookup.AbstractPathFencedLookup

org.apache.commons.text.lookup.PropertiesStringLookup

All Implemented Interfaces:

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

final class PropertiesStringLookup
extends AbstractPathFencedLookup

Looks up keys from a properties file.

Looks up the value for a given key in the format "Document::Key".

Note the use of "::" instead of ":" to allow for "C:" drive letters in paths.

For example: "com/domain/document.properties:key".

Public access is through StringLookupFactory.

Since:

1.5

See Also:

• StringLookupFactory
• Properties

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final PropertiesStringLookup	INSTANCE	Defines the singleton for this class.
(package private) static final String	SEPARATOR	Separates file and key.

Fields inherited from class org.apache.commons.text.lookup.AbstractPathFencedLookup

fence

Fields inherited from class org.apache.commons.text.lookup.AbstractStringLookup

SPLIT_CH, SPLIT_STR

Constructor Summary

Constructors

Constructor	Description
PropertiesStringLookup(Path... fences)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
String	lookup(String key)	Looks up the value for the key in the format "DocumentPath:XPath".
(package private) static String	toPropertyKey(String file, String key)	Creates a lookup key for a given file and key.

Methods inherited from class org.apache.commons.text.lookup.AbstractPathFencedLookup

getPath

Methods inherited from class org.apache.commons.text.lookup.AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.commons.text.lookup.StringLookup

apply

Field Details

INSTANCE

static final PropertiesStringLookup INSTANCE

Defines the singleton for this class.

SEPARATOR

static final String SEPARATOR

Separates file and key.

See Also:

• Constant Field Values

Constructor Details

PropertiesStringLookup

PropertiesStringLookup(Path... fences)

Constructs a new instance.

Parameters:

fences - The fences guarding Path resolution.

Method Details

toPropertyKey

static String toPropertyKey(String file,
 String key)

Creates a lookup key for a given file and key.

lookup

public String lookup(String key)

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

For example: "com/domain/document.xml::/path/to/node".

Note the use of "::" instead of ":" to allow for "C:" drive letters in paths.

Parameters:

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

Returns:

The value associated with the key.