Package org.apache.commons.text.lookup

Provides algorithms for looking up strings for use with a StringSubstitutor. The main class in this package is StringLookupFactory.

Use StringLookupFactory to create instances of string lookups or access singleton string lookups. The main interface is StringLookup which is implemented here in package private classes.

Like BiFunction is a variant of Function, this BiStringLookup is a variant of StringLookup.

The initial implementation was adapted from Apache Commons Log4j 2.11.0.

Since:

1.3

Interface Summary

Interface	Description
BiStringLookup<U>	Lookups a String key for a String value.
StringLookup	Lookups a String key for a String value.

Class Summary

Class	Description
AbstractStringLookup	A default lookup for others to extend in this package.
BiFunctionStringLookup<P,R>	A function-based lookup where the request for a lookup is answered by applying that function with a key.
ConstantStringLookup	Looks up the value of a fully-qualified static final value.
DateStringLookup	Formats the current date with the format given in the key in a format compatible with SimpleDateFormat.
DnsStringLookup	Looks up keys related to DNS entries like host name, canonical host name, host address.
FileStringLookup	Looks up keys from an XML document.
FunctionStringLookup<V>	A function-based lookup where the request for a lookup is answered by applying that function with a key.
IllegalArgumentExceptions	Shorthands creating IllegalArgumentException instances using formatted strings.
InetAddressKeys	Constants for referring to InetAddress APIs.
InterpolatorStringLookup	Proxies other StringLookups using a keys within ${} markers using the format "${StringLookup:Key}".
JavaPlatformStringLookup	Looks up keys related to Java: Java version, JRE version, VM version, and so on.
LocalHostStringLookup	Looks up keys related to the local host: host name, canonical host name, host address.
PropertiesStringLookup	Looks up keys from an XML document.
ResourceBundleStringLookup	Looks up keys from resource bundles.
ScriptStringLookup	Executes the script with the given engine name.
StringLookupFactory	Create instances of string lookups or access singleton string lookups implemented in this package.
UrlDecoderStringLookup	Decodes URL Strings using the UTF-8 encoding.
UrlEncoderStringLookup	Encodes URL Strings using the UTF-8 encoding.
UrlStringLookup	Looks up keys from an XML document.
XmlStringLookup	Looks up keys from an XML document.

Enum Summary

Enum	Description
DefaultStringLookup	An enumeration defining StringLookup objects available through StringLookupFactory.