Package org.apache.commons.text.lookup

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

Related Packages

Package	Description
org.apache.commons.text	Basic classes for text handling.

Class	Description
AbstractPathFencedLookup	Abstracts string lookup that guards Path lookups with a fence.
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.
BiStringLookup<U>	Lookups a String key for a String value.
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.
DefaultStringLookup	An enumeration defining StringLookup objects available through StringLookupFactory.
DnsStringLookup	Looks up keys related to DNS entries like host name, canonical host name, host address.
FileStringLookup	Looks up file contents.
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.
InetAddressStringLookup	Looks up keys related to an invalid reference InetAddresse .
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.
PathFence	A Path fence guards against using paths outside of a "fence" of made of root paths.
PathFence.Builder	Builds PathFence instances.
PropertiesStringLookup	Looks up keys from a properties file.
ResourceBundleStringLookup	Looks up keys from resource bundles.
ScriptStringLookup	Executes the script with the given engine name.
StringLookup	Lookups a String key for a String value.
StringLookupFactory	Create instances of string lookups or access singleton string lookups implemented in this package.
StringLookupFactory.Builder	Builds instance of StringLookupFactory.
StringLookupFactory.DefaultStringLookupsHolder	Internal class used to construct the default StringLookup map used by StringLookupFactory.addDefaultStringLookups(Map).
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.
XmlDecoderStringLookup	Decodes strings according to the XML 1.0 specification.
XmlEncoderStringLookup	Encodes strings according to the XML 1.0 specification.
XmlStringLookup	Looks up values in an XML document in the format "DocumentPath:XPath".