Uses of Interface
org.apache.commons.text.lookup.StringLookup

Packages that use StringLookup

Package	Description
org.apache.commons.text	Basic classes for text handling.
org.apache.commons.text.lookup	Provides algorithms for looking up strings for use with a StringSubstitutor.

Uses of StringLookup in org.apache.commons.text

Classes in org.apache.commons.text that implement StringLookup

Modifier and Type	Class	Description
class	StrLookup<V>	Deprecated. Deprecated as of 1.3, use StringLookupFactory instead.
private static final class	StrLookup.MapStrLookup<V>	Deprecated. Lookup implementation that uses a Map.
private static final class	StrLookup.ResourceBundleLookup	Deprecated. Lookup implementation based on a ResourceBundle.
private static final class	StrLookup.SystemPropertiesStrLookup	Deprecated. Lookup implementation based on system properties.

Fields in org.apache.commons.text declared as StringLookup

Modifier and Type	Field	Description
private StringLookup	StringSubstitutor.variableResolver	Variable resolution is delegated to an implementor of StringLookup.

Methods in org.apache.commons.text that return StringLookup

Modifier and Type	Method	Description
StringLookup	StringSubstitutor.getStringLookup()	Gets the StringLookup that is used to lookup variables.

Methods in org.apache.commons.text with parameters of type StringLookup

Modifier and Type	Method	Description
StringSubstitutor	StringSubstitutor.setVariableResolver(StringLookup variableResolver)	Sets the VariableResolver that is used to lookup variables.

Constructors in org.apache.commons.text with parameters of type StringLookup

Modifier	Constructor	Description
	StringSubstitutor(StringLookup variableResolver)	Constructs a new initialized instance.
	StringSubstitutor(StringLookup variableResolver, String prefix, String suffix, char escape)	Constructs a new initialized instance.
	StringSubstitutor(StringLookup variableResolver, String prefix, String suffix, char escape, String valueDelimiter)	Constructs a new initialized instance.
	StringSubstitutor(StringLookup variableResolver, StringMatcher prefixMatcher, StringMatcher suffixMatcher, char escape)	Constructs a new initialized instance.
	StringSubstitutor(StringLookup variableResolver, StringMatcher prefixMatcher, StringMatcher suffixMatcher, char escape, StringMatcher valueDelimiterMatcher)	Constructs a new initialized instance.

Uses of StringLookup in org.apache.commons.text.lookup

Subinterfaces of StringLookup in org.apache.commons.text.lookup

Modifier and Type	Interface	Description
interface	BiStringLookup<U>	Lookups a String key for a String value.

Classes in org.apache.commons.text.lookup that implement StringLookup

Modifier and Type	Class	Description
(package private) class	AbstractPathFencedLookup	Abstracts string lookup that guards Path lookups with a fence.
(package private) class	AbstractStringLookup	A default lookup for others to extend in this package.
(package private) final class	BiFunctionStringLookup<P,R>	A function-based lookup where the request for a lookup is answered by applying that function with a key.
(package private) class	ConstantStringLookup	Looks up the value of a fully-qualified static final value.
(package private) final class	DateStringLookup	Formats the current date with the format given in the key in a format compatible with SimpleDateFormat.
(package private) final class	DnsStringLookup	Looks up keys related to DNS entries like host name, canonical host name, host address.
(package private) final class	FileStringLookup	Looks up file contents.
(package private) final class	FunctionStringLookup<V>	A function-based lookup where the request for a lookup is answered by applying that function with a key.
(package private) final class	InetAddressStringLookup	Looks up keys related to an invalid reference InetAddresse .
(package private) final class	InterpolatorStringLookup	Proxies other StringLookups using a keys within ${} markers using the format "${StringLookup:Key}".
(package private) final class	JavaPlatformStringLookup	Looks up keys related to Java: Java version, JRE version, VM version, and so on.
(package private) final class	PropertiesStringLookup	Looks up keys from a properties file.
(package private) final class	ResourceBundleStringLookup	Looks up keys from resource bundles.
(package private) final class	ScriptStringLookup	Executes the script with the given engine name.
(package private) final class	UrlDecoderStringLookup	Decodes URL Strings using the UTF-8 encoding.
(package private) final class	UrlEncoderStringLookup	Encodes URL Strings using the UTF-8 encoding.
(package private) final class	UrlStringLookup	Looks up keys from an XML document.
(package private) final class	XmlDecoderStringLookup	Decodes strings according to the XML 1.0 specification.
(package private) final class	XmlEncoderStringLookup	Encodes strings according to the XML 1.0 specification.
(package private) final class	XmlStringLookup	Looks up values in an XML document in the format "DocumentPath:XPath".

Fields in org.apache.commons.text.lookup declared as StringLookup

Modifier and Type	Field	Description
private final StringLookup	InterpolatorStringLookup.defaultStringLookup	The default string lookup.
private final StringLookup	DefaultStringLookup.lookup	The associated lookup instance.

Fields in org.apache.commons.text.lookup with type parameters of type StringLookup

Modifier and Type	Field	Description
private final Map<String, StringLookup>	StringLookupFactory.DefaultStringLookupsHolder.defaultStringLookups	Default string lookup map.
private final Map<String, StringLookup>	InterpolatorStringLookup.stringLookupMap	The map of String lookups keyed by prefix.

Methods in org.apache.commons.text.lookup that return StringLookup

Modifier and Type	Method	Description
StringLookup	StringLookupFactory.base64DecoderStringLookup()	Returns the Base64DecoderStringLookup singleton instance to decode Base64 strings.
StringLookup	StringLookupFactory.base64EncoderStringLookup()	Returns the Base64EncoderStringLookup singleton instance to encode strings to Base64.
StringLookup	StringLookupFactory.base64StringLookup()	Deprecated. Use StringLookupFactory.base64DecoderStringLookup().
StringLookup	StringLookupFactory.constantStringLookup()	Returns the ConstantStringLookup singleton instance to look up the value of a fully-qualified static final value.
StringLookup	StringLookupFactory.dateStringLookup()	Returns the DateStringLookup singleton instance to format the current date with the format given in the key in a format compatible with SimpleDateFormat.
StringLookup	StringLookupFactory.dnsStringLookup()	Returns the DnsStringLookup singleton instance where the lookup key is one of: name: for the local host name, for example EXAMPLE but also EXAMPLE.apache.org. canonical-name: for the local canonical host name, for example EXAMPLE.apache.org. address: for the local host address, for example 192.168.56.1.
StringLookup	StringLookupFactory.environmentVariableStringLookup()	Returns the EnvironmentVariableStringLookup singleton instance where the lookup key is an environment variable name.
StringLookup	StringLookupFactory.fileStringLookup()	Returns a file StringLookup instance.
StringLookup	StringLookupFactory.fileStringLookup(Path... fences)	Returns a fenced file StringLookup instance.
<R> StringLookup	StringLookupFactory.functionStringLookup(Function<String,R> function)	Returns a new function-based lookup where the request for a lookup is answered by applying the function with a lookup key.
StringLookup	DefaultStringLookup.getStringLookup()	Gets the standard StringLookup instance of this kind.
StringLookup	StringLookupFactory.interpolatorStringLookup()	Returns a InterpolatorStringLookup containing the configured default lookups.
StringLookup	StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)	Returns a new InterpolatorStringLookup.
<V> StringLookup	StringLookupFactory.interpolatorStringLookup(Map<String,V> map)	Returns a new InterpolatorStringLookup using the given key-value pairs and the configured default lookups to resolve variables.
StringLookup	StringLookupFactory.interpolatorStringLookup(StringLookup defaultStringLookup)	Returns a new InterpolatorStringLookup using the given lookup and the configured default lookups to resolve variables.
StringLookup	StringLookupFactory.javaPlatformStringLookup()	Returns the JavaPlatformStringLookup singleton instance.
StringLookup	StringLookupFactory.localHostStringLookup()	Returns the InetAddressStringLookup instance where the lookup key for InetAddress.getLocalHost() is one of: name: for the local host name, for example EXAMPLE. canonical-name: for the local canonical host name, for example EXAMPLE.apache.org. address: for the local host address, for example 192.168.56.1.
StringLookup	StringLookupFactory.loopbackAddressStringLookup()	Returns the InetAddressStringLookup instance where the lookup key for InetAddress.getLoopbackAddress() is one of: name: for the local host name, for example EXAMPLE. canonical-name: for the local canonical host name, for example EXAMPLE.apache.org. address: for the local host address, for example 192.168.56.1.
<V> StringLookup	StringLookupFactory.mapStringLookup(Map<String,V> map)	Returns a new map-based lookup where the request for a lookup is answered with the value for that key.
StringLookup	StringLookupFactory.nullStringLookup()	Returns the NullStringLookup singleton instance which always returns null.
StringLookup	StringLookupFactory.propertiesStringLookup()	Returns a Properties StringLookup instance.
StringLookup	StringLookupFactory.propertiesStringLookup(Path... fences)	Returns a fenced Properties StringLookup instance.
StringLookup	StringLookupFactory.resourceBundleStringLookup()	Returns the ResourceBundleStringLookup singleton instance.
StringLookup	StringLookupFactory.resourceBundleStringLookup(String bundleName)	Returns a ResourceBundleStringLookup instance for the given bundle name.
StringLookup	StringLookupFactory.scriptStringLookup()	Returns the ScriptStringLookup singleton instance.
StringLookup	StringLookupFactory.systemPropertyStringLookup()	Returns the SystemPropertyStringLookup singleton instance where the lookup key is a system property name.
StringLookup	StringLookupFactory.urlDecoderStringLookup()	Returns the UrlDecoderStringLookup singleton instance.
StringLookup	StringLookupFactory.urlEncoderStringLookup()	Returns the UrlDecoderStringLookup singleton instance.
StringLookup	StringLookupFactory.urlStringLookup()	Returns the UrlStringLookup singleton instance.
StringLookup	StringLookupFactory.xmlDecoderStringLookup()	Returns the XmlDecoderStringLookup singleton instance.
StringLookup	StringLookupFactory.xmlEncoderStringLookup()	Returns the XmlEncoderStringLookup singleton instance.
StringLookup	StringLookupFactory.xmlStringLookup()	Returns an XML StringLookup instance.
StringLookup	StringLookupFactory.xmlStringLookup(Map<String,Boolean> factoryFeatures)	Returns an XML StringLookup instance.
StringLookup	StringLookupFactory.xmlStringLookup(Map<String,Boolean> factoryFeatures, Path... fences)	Returns a fenced XML StringLookup instance.

Methods in org.apache.commons.text.lookup that return types with arguments of type StringLookup

Modifier and Type	Method	Description
private static Map<String, StringLookup>	StringLookupFactory.DefaultStringLookupsHolder.createDefaultStringLookups()	Creates the lookup map used when the user has requested no customization.
(package private) Map<String, StringLookup>	StringLookupFactory.DefaultStringLookupsHolder.getDefaultStringLookups()	Gets the default string lookups map.
Map<String, StringLookup>	InterpolatorStringLookup.getStringLookupMap()	Gets the lookup map.
private static Map<String, StringLookup>	StringLookupFactory.DefaultStringLookupsHolder.parseStringLookups(String str)	Constructs a lookup map by parsing the given string.

Methods in org.apache.commons.text.lookup with parameters of type StringLookup

Modifier and Type	Method	Description
StringLookup	StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)	Returns a new InterpolatorStringLookup.
StringLookup	StringLookupFactory.interpolatorStringLookup(StringLookup defaultStringLookup)	Returns a new InterpolatorStringLookup using the given lookup and the configured default lookups to resolve variables.

Method parameters in org.apache.commons.text.lookup with type arguments of type StringLookup

Modifier and Type	Method	Description
void	StringLookupFactory.addDefaultStringLookups(Map<String, StringLookup> stringLookupMap)	Adds the default string lookups for this class to stringLookupMap.
private static void	StringLookupFactory.DefaultStringLookupsHolder.addLookup(DefaultStringLookup lookup, Map<String, StringLookup> map)	Adds the key and string lookup from lookup to map, also adding any additional key aliases if needed.
StringLookup	StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)	Returns a new InterpolatorStringLookup.

Constructors in org.apache.commons.text.lookup with parameters of type StringLookup

Modifier	Constructor	Description
private	DefaultStringLookup(String prefix, StringLookup lookup)	Constructs a new instance of DefaultStringLookup and sets the key and the associated lookup instance.
(package private)	InterpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)	Constructs a fully customized instance.
(package private)	InterpolatorStringLookup(StringLookup defaultStringLookup)	Constructs an instance with the given lookup.

Constructor parameters in org.apache.commons.text.lookup with type arguments of type StringLookup

Modifier	Constructor	Description
(package private)	InterpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)	Constructs a fully customized instance.