Uses of Interface
org.apache.commons.text.lookup.StringLookup
Packages that use StringLookup
Package
Description
Basic classes for text handling.
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 StringLookupModifier and TypeClassDescriptionclass
StrLookup<V>
Deprecated.(package private) static class
Deprecated.Lookup implementation that uses a Map.private static final class
Deprecated.Lookup implementation based on a ResourceBundle.private static final class
Deprecated.Lookup implementation based on system properties.Fields in org.apache.commons.text declared as StringLookupModifier and TypeFieldDescriptionprivate StringLookup
StringSubstitutor.variableResolver
Variable resolution is delegated to an implementor ofStringLookup
.Methods in org.apache.commons.text that return StringLookupModifier and TypeMethodDescriptionStringSubstitutor.getStringLookup()
Gets the StringLookup that is used to lookup variables.Methods in org.apache.commons.text with parameters of type StringLookupModifier and TypeMethodDescriptionStringSubstitutor.setVariableResolver
(StringLookup variableResolver) Sets the VariableResolver that is used to lookup variables.Constructors in org.apache.commons.text with parameters of type StringLookupModifierConstructorDescriptionStringSubstitutor
(StringLookup variableResolver) Creates a new instance and initializes it.StringSubstitutor
(StringLookup variableResolver, String prefix, String suffix, char escape) Creates a new instance and initializes it.StringSubstitutor
(StringLookup variableResolver, String prefix, String suffix, char escape, String valueDelimiter) Creates a new instance and initializes it.StringSubstitutor
(StringLookup variableResolver, StringMatcher prefixMatcher, StringMatcher suffixMatcher, char escape) Creates a new instance and initializes it.StringSubstitutor
(StringLookup variableResolver, StringMatcher prefixMatcher, StringMatcher suffixMatcher, char escape, StringMatcher valueDelimiterMatcher) Creates a new instance and initializes it. -
Uses of StringLookup in org.apache.commons.text.lookup
Subinterfaces of StringLookup in org.apache.commons.text.lookupModifier and TypeInterfaceDescriptioninterface
Lookups a String key for a String value.Classes in org.apache.commons.text.lookup that implement StringLookupModifier and TypeClassDescription(package private) class
A default lookup for others to extend in this package.(package private) final class
A function-based lookup where the request for a lookup is answered by applying that function with a key.(package private) class
Looks up the value of a fully-qualified static final value.(package private) final class
Formats the current date with the format given in the key in a format compatible withSimpleDateFormat
.(package private) final class
Looks up keys related to DNS entries like host name, canonical host name, host address.(package private) final class
Looks up keys from a file.(package private) final class
A function-based lookup where the request for a lookup is answered by applying that function with a key.(package private) class
Proxies otherStringLookup
s using a keys within ${} markers using the format "${StringLookup:Key}".(package private) final class
Looks up keys related to Java: Java version, JRE version, VM version, and so on.(package private) final class
Looks up keys related to the local host: host name, canonical host name, host address.(package private) final class
Looks up keys from a properties file.(package private) final class
Looks up keys from resource bundles.(package private) final class
Executes the script with the given engine name.(package private) final class
Decodes URL Strings using the UTF-8 encoding.(package private) final class
Encodes URL Strings using the UTF-8 encoding.(package private) final class
Looks up keys from an XML document.(package private) final class
Looks up keys from an XML document.Fields in org.apache.commons.text.lookup declared as StringLookupModifier and TypeFieldDescriptionprivate 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 StringLookupModifier and TypeFieldDescriptionprivate 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 StringLookupModifier and TypeMethodDescriptionStringLookupFactory.base64DecoderStringLookup()
Returns the Base64DecoderStringLookup singleton instance to decode Base64 strings.StringLookupFactory.base64EncoderStringLookup()
Returns the Base64EncoderStringLookup singleton instance to encode strings to Base64.StringLookupFactory.base64StringLookup()
Deprecated.StringLookupFactory.constantStringLookup()
Returns the ConstantStringLookup singleton instance to look up the value of a fully-qualified static final value.StringLookupFactory.dateStringLookup()
Returns the DateStringLookup singleton instance to format the current date with the format given in the key in a format compatible withSimpleDateFormat
.StringLookupFactory.dnsStringLookup()
Returns the DnsStringLookup singleton instance where the lookup key is one of: name: for the local host name, for exampleEXAMPLE
but alsoEXAMPLE.apache.org
. canonical-name: for the local canonical host name, for exampleEXAMPLE.apache.org
. address: for the local host address, for example192.168.56.1
.StringLookupFactory.environmentVariableStringLookup()
Returns the EnvironmentVariableStringLookup singleton instance where the lookup key is an environment variable name.StringLookupFactory.fileStringLookup()
Returns the FileStringLookup singleton 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.DefaultStringLookup.getStringLookup()
Returns the standardStringLookup
instance of this kind.StringLookupFactory.interpolatorStringLookup()
Returns aInterpolatorStringLookup
containing the configureddefault lookups
.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 configureddefault lookups
to resolve variables.StringLookupFactory.interpolatorStringLookup
(StringLookup defaultStringLookup) Returns a new InterpolatorStringLookup using the given lookup and the configureddefault lookups
to resolve variables.StringLookupFactory.javaPlatformStringLookup()
Returns the JavaPlatformStringLookup singleton instance.StringLookupFactory.localHostStringLookup()
Returns the LocalHostStringLookup singleton instance where the lookup key is one of: name: for the local host name, for exampleEXAMPLE
. canonical-name: for the local canonical host name, for exampleEXAMPLE.apache.org
. address: for the local host address, for example192.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.StringLookupFactory.nullStringLookup()
Returns the NullStringLookup singleton instance which always returns null.StringLookupFactory.propertiesStringLookup()
Returns the PropertiesStringLookup singleton instance.StringLookupFactory.resourceBundleStringLookup()
Returns the ResourceBundleStringLookup singleton instance.StringLookupFactory.resourceBundleStringLookup
(String bundleName) Returns a ResourceBundleStringLookup instance for the given bundle name.StringLookupFactory.scriptStringLookup()
Returns the ScriptStringLookup singleton instance.StringLookupFactory.systemPropertyStringLookup()
Returns the SystemPropertyStringLookup singleton instance where the lookup key is a system property name.StringLookupFactory.urlDecoderStringLookup()
Returns the UrlDecoderStringLookup singleton instance.StringLookupFactory.urlEncoderStringLookup()
Returns the UrlDecoderStringLookup singleton instance.StringLookupFactory.urlStringLookup()
Returns the UrlStringLookup singleton instance.StringLookupFactory.xmlStringLookup()
Returns the XmlStringLookup singleton instance.Methods in org.apache.commons.text.lookup that return types with arguments of type StringLookupModifier and TypeMethodDescriptionprivate static Map
<String, StringLookup> StringLookupFactory.DefaultStringLookupsHolder.createDefaultStringLookups()
Create the lookup map used when the user has requested no customization.(package private) Map
<String, StringLookup> StringLookupFactory.DefaultStringLookupsHolder.getDefaultStringLookups()
Get the default string lookups map.InterpolatorStringLookup.getStringLookupMap()
Gets the lookup map.private static Map
<String, StringLookup> StringLookupFactory.DefaultStringLookupsHolder.parseStringLookups
(String str) Construct a lookup map by parsing the given string.Methods in org.apache.commons.text.lookup with parameters of type StringLookupModifier and TypeMethodDescriptionStringLookupFactory.interpolatorStringLookup
(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups) Returns a new InterpolatorStringLookup.StringLookupFactory.interpolatorStringLookup
(StringLookup defaultStringLookup) Returns a new InterpolatorStringLookup using the given lookup and the configureddefault lookups
to resolve variables.Method parameters in org.apache.commons.text.lookup with type arguments of type StringLookupModifier and TypeMethodDescriptionvoid
StringLookupFactory.addDefaultStringLookups
(Map<String, StringLookup> stringLookupMap) Adds the default string lookups for this class tostringLookupMap
.private static void
StringLookupFactory.DefaultStringLookupsHolder.addLookup
(DefaultStringLookup lookup, Map<String, StringLookup> map) Add the key and string lookup fromlookup
tomap
, also adding any additional key aliases if needed.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 StringLookupModifierConstructorDescriptionprivate
DefaultStringLookup
(String prefix, StringLookup lookup) Creates a new instance ofDefaultStringLookup
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 StringLookupModifierConstructorDescription(package private)
InterpolatorStringLookup
(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups) Constructs a fully customized instance.
StringLookupFactory
instead.