# 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.
  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.
  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 LocalHostStringLookup singleton instance where the lookup key 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> xPathFactoryFeatures)`
  Returns an XML StringLookup instance.
  `StringLookup`
  StringLookupFactory.`xmlStringLookup(Map<String,Boolean> xPathFactoryFeatures, Path... fences)`
  Returns a fenced XML StringLookup instance.
  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`.
  `StringLookup`
  StringLookupFactory.`interpolatorStringLookup(Map<String,StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)`
  Returns a new InterpolatorStringLookup.