Class StringLookupFactory
The "classic" look up is mapStringLookup(Map)
.
The methods for variable interpolation (A.K.A. variable substitution) are:
interpolatorStringLookup()
.interpolatorStringLookup(Map)
.interpolatorStringLookup(StringLookup)
.interpolatorStringLookup(Map, StringLookup, boolean)
.
The default lookups are:
We also provide functional lookups used as building blocks for other lookups.
Interface | Factory Method | Since |
---|---|---|
BiStringLookup |
biFunctionStringLookup(BiFunction) |
1.9 |
StringLookup |
functionStringLookup(Function) |
1.9 |
- Since:
- 1.3
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringLookupFactory
Defines the singleton for this class.(package private) static final FunctionStringLookup<String>
Decodes Base64 Strings.(package private) static final FunctionStringLookup<String>
Encodes Base64 Strings.(package private) static final FunctionStringLookup<String>
Looks up keys from environment variables.(package private) static final FunctionStringLookup<String>
Defines the FunctionStringLookup singleton that always returns null.(package private) static final FunctionStringLookup<String>
Defines the FunctionStringLookup singleton for looking up system properties.static final String
Default lookup key for interpolation "base64Decoder".static final String
Default lookup key for interpolation "base64Encoder".static final String
Default lookup key for interpolation "const".static final String
Default lookup key for interpolation "date".static final String
Default lookup key for interpolation "dns".static final String
Default lookup key for interpolation "env".static final String
Default lookup key for interpolation "file".static final String
Default lookup key for interpolation "java".static final String
Default lookup key for interpolation "localhost".static final String
Default lookup key for interpolation "properties".static final String
Default lookup key for interpolation "resourceBundle".static final String
Default lookup key for interpolation "script".static final String
Default lookup key for interpolation "sys".static final String
Default lookup key for interpolation "url".static final String
Default lookup key for interpolation "urlDecoder".static final String
Default lookup key for interpolation "urlEncoder".static final String
Default lookup key for interpolation "xml". -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultStringLookups
(Map<String, StringLookup> stringLookupMap) Adds thedefault lookups
.Returns the Base64DecoderStringLookup singleton instance to decode Base64 strings.Returns the Base64EncoderStringLookup singleton instance to encode strings to Base64.Deprecated.<R,
U> BiStringLookup<U> biFunctionStringLookup
(BiFunction<String, U, R> biFunction) Returns a new function-based lookup where the request for a lookup is answered by applying the function with a lookup key.static void
clear()
Clears any static resources.Returns the ConstantStringLookup singleton instance to look up the value of a fully-qualified static final value.Returns the DateStringLookup singleton instance to format the current date with the format given in the key in a format compatible withSimpleDateFormat
.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
.Returns the EnvironmentVariableStringLookup singleton instance where the lookup key is an environment variable name.Returns the FileStringLookup singleton instance.<R> StringLookup
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.Returns a new InterpolatorStringLookup using thedefault lookups
.interpolatorStringLookup
(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups) Returns a new InterpolatorStringLookup using thedefault lookups
.<V> StringLookup
interpolatorStringLookup
(Map<String, V> map) Returns a new InterpolatorStringLookup using thedefault lookups
.interpolatorStringLookup
(StringLookup defaultStringLookup) Returns a new InterpolatorStringLookup using thedefault lookups
.Returns the JavaPlatformStringLookup singleton instance.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
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.Returns the NullStringLookup singleton instance which always returns null.Returns the PropertiesStringLookup singleton instance.Returns the ResourceBundleStringLookup singleton instance.resourceBundleStringLookup
(String bundleName) Returns a ResourceBundleStringLookup instance for the given bundle name.Returns the ScriptStringLookup singleton instance.Returns the SystemPropertyStringLookup singleton instance where the lookup key is a system property name.Returns the UrlDecoderStringLookup singleton instance.Returns the UrlDecoderStringLookup singleton instance.Returns the UrlStringLookup singleton instance.Returns the XmlStringLookup singleton instance.
-
Field Details
-
INSTANCE
Defines the singleton for this class. -
INSTANCE_BASE64_DECODER
Decodes Base64 Strings.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.base64DecoderStringLookup().lookup("SGVsbG9Xb3JsZCE=");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${base64Decoder:SGVsbG9Xb3JsZCE=} ..."));
The above examples convert
"SGVsbG9Xb3JsZCE="
to"HelloWorld!"
. -
INSTANCE_BASE64_ENCODER
Encodes Base64 Strings.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.base64EncoderStringLookup().lookup("HelloWorld!");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${base64Encoder:HelloWorld!} ..."));
The above examples convert
Defines the singleton for this class."HelloWorld!"
to"SGVsbG9Xb3JsZCE="
. -
INSTANCE_ENVIRONMENT_VARIABLES
Looks up keys from environment variables.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.dateStringLookup().lookup("USER");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${env:USER} ..."));
The above examples convert (on Linux)
"USER"
to the current user name. On Windows 10, you would use"USERNAME"
to the same effect. -
INSTANCE_NULL
Defines the FunctionStringLookup singleton that always returns null. -
INSTANCE_SYSTEM_PROPERTIES
Defines the FunctionStringLookup singleton for looking up system properties. -
KEY_BASE64_DECODER
Default lookup key for interpolation "base64Decoder".- Since:
- 1.6
- See Also:
-
KEY_BASE64_ENCODER
Default lookup key for interpolation "base64Encoder".- Since:
- 1.6
- See Also:
-
KEY_CONST
Default lookup key for interpolation "const".- Since:
- 1.6
- See Also:
-
KEY_DATE
Default lookup key for interpolation "date".- Since:
- 1.6
- See Also:
-
KEY_DNS
Default lookup key for interpolation "dns".- Since:
- 1.8
- See Also:
-
KEY_ENV
Default lookup key for interpolation "env".- Since:
- 1.6
- See Also:
-
KEY_FILE
Default lookup key for interpolation "file".- Since:
- 1.6
- See Also:
-
KEY_JAVA
Default lookup key for interpolation "java".- Since:
- 1.6
- See Also:
-
KEY_LOCALHOST
Default lookup key for interpolation "localhost".- Since:
- 1.6
- See Also:
-
KEY_PROPERTIES
Default lookup key for interpolation "properties".- Since:
- 1.6
- See Also:
-
KEY_RESOURCE_BUNDLE
Default lookup key for interpolation "resourceBundle".- Since:
- 1.6
- See Also:
-
KEY_SCRIPT
Default lookup key for interpolation "script".- Since:
- 1.6
- See Also:
-
KEY_SYS
Default lookup key for interpolation "sys".- Since:
- 1.6
- See Also:
-
KEY_URL
Default lookup key for interpolation "url".- Since:
- 1.6
- See Also:
-
KEY_URL_DECODER
Default lookup key for interpolation "urlDecoder".- Since:
- 1.6
- See Also:
-
KEY_URL_ENCODER
Default lookup key for interpolation "urlEncoder".- Since:
- 1.6
- See Also:
-
KEY_XML
Default lookup key for interpolation "xml".- Since:
- 1.6
- See Also:
-
-
Constructor Details
-
StringLookupFactory
private StringLookupFactory()No need to build instances for now.
-
-
Method Details
-
clear
public static void clear()Clears any static resources.- Since:
- 1.5
-
addDefaultStringLookups
Adds thedefault lookups
.- Parameters:
stringLookupMap
- the map of string lookups.- Since:
- 1.5
-
base64DecoderStringLookup
Returns the Base64DecoderStringLookup singleton instance to decode Base64 strings.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.base64DecoderStringLookup().lookup("SGVsbG9Xb3JsZCE=");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${base64Decoder:SGVsbG9Xb3JsZCE=} ..."));
The above examples convert
"SGVsbG9Xb3JsZCE="
to"HelloWorld!"
.- Returns:
- The DateStringLookup singleton instance.
- Since:
- 1.5
-
base64EncoderStringLookup
Returns the Base64EncoderStringLookup singleton instance to encode strings to Base64.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.base64EncoderStringLookup().lookup("HelloWorld!");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${base64Encoder:HelloWorld!} ..."));
The above examples convert to
"SGVsbG9Xb3JsZCE="
.- Returns:
- The DateStringLookup singleton instance.
- Since:
- 1.6
-
base64StringLookup
Deprecated.Returns the Base64DecoderStringLookup singleton instance to decode Base64 strings.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.base64DecoderStringLookup().lookup("SGVsbG9Xb3JsZCE=");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${base64Decoder:SGVsbG9Xb3JsZCE=} ..."));
The above examples convert
"SGVsbG9Xb3JsZCE="
to"HelloWorld!"
.- Returns:
- The DateStringLookup singleton instance.
- Since:
- 1.5
-
biFunctionStringLookup
Returns a new function-based lookup where the request for a lookup is answered by applying the function with a lookup key.- Type Parameters:
R
- the function return type.U
- the function's second parameter type.- Parameters:
biFunction
- the function.- Returns:
- a new MapStringLookup.
- Since:
- 1.9
-
constantStringLookup
Returns the ConstantStringLookup singleton instance to look up the value of a fully-qualified static final value.Sometimes it is necessary in a configuration file to refer to a constant defined in a class. This can be done with this lookup implementation. Variable names must be in the format
apackage.AClass.AFIELD
. Thelookup(String)
method will split the passed in string at the last dot, separating the fully qualified class name and the name of the constant (i.e. static final) member field. Then the class is loaded and the field's value is obtained using reflection.Once retrieved values are cached for fast access. This class is thread-safe. It can be used as a standard (i.e. global) lookup object and serve multiple clients concurrently.
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.constantStringLookup().lookup("java.awt.event.KeyEvent.VK_ESCAPE");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${const:java.awt.event.KeyEvent.VK_ESCAPE} ..."));
The above examples convert
java.awt.event.KeyEvent.VK_ESCAPE
to"27"
.- Returns:
- The DateStringLookup singleton instance.
- Since:
- 1.5
-
dateStringLookup
Returns the DateStringLookup singleton instance to format the current date with the format given in the key in a format compatible withSimpleDateFormat
.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.dateStringLookup().lookup("yyyy-MM-dd");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${date:yyyy-MM-dd} ..."));
The above examples convert
"yyyy-MM-dd"
to todays's date, for example,"2019-08-04"
.- Returns:
- The DateStringLookup singleton instance.
-
dnsStringLookup
Returns the DnsStringLookup singleton instance where the lookup key is one of:- name: for the local host name, for example
EXAMPLE
but alsoEXAMPLE.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
.
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.dnsStringLookup().lookup("address|apache.org");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${dns:address|apache.org} ..."));
The above examples convert
"address|apache.org"
to"95.216.24.32
(or"40.79.78.1"
).- Returns:
- the DateStringLookup singleton instance.
- Since:
- 1.8
- name: for the local host name, for example
-
environmentVariableStringLookup
Returns the EnvironmentVariableStringLookup singleton instance where the lookup key is an environment variable name.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.dateStringLookup().lookup("USER");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${env:USER} ..."));
The above examples convert (on Linux)
"USER"
to the current user name. On Windows 10, you would use"USERNAME"
to the same effect.- Returns:
- The EnvironmentVariableStringLookup singleton instance.
-
fileStringLookup
Returns the FileStringLookup singleton instance.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.fileStringLookup().lookup("UTF-8:com/domain/document.properties");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${file:UTF-8:com/domain/document.properties} ..."));
The above examples convert
"UTF-8:com/domain/document.properties"
to the contents of the file.- Returns:
- The FileStringLookup singleton instance.
- Since:
- 1.5
-
functionStringLookup
Returns a new function-based lookup where the request for a lookup is answered by applying the function with a lookup key.- Type Parameters:
R
- the function return type.- Parameters:
function
- the function.- Returns:
- a new MapStringLookup.
- Since:
- 1.9
-
interpolatorStringLookup
Returns a new InterpolatorStringLookup using thedefault lookups
.The lookups available to an interpolator are defined in
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.interpolatorStringLookup().lookup("${sys:os.name}, ${env:USER}");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${sys:os.name}, ${env:USER} ..."));
The above examples convert
"${sys:os.name}, ${env:USER}"
to the OS name and Linux user name.- Returns:
- a new InterpolatorStringLookup.
-
interpolatorStringLookup
public StringLookup interpolatorStringLookup(Map<String, StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups) Returns a new InterpolatorStringLookup using thedefault lookups
.If
addDefaultLookups
is true, the following lookups are used in addition to the ones provided instringLookupMap
:- Parameters:
stringLookupMap
- the map of string lookups.defaultStringLookup
- the default string lookup.addDefaultLookups
- whether to use lookups as described above.- Returns:
- a new InterpolatorStringLookup.
- Since:
- 1.4
-
interpolatorStringLookup
Returns a new InterpolatorStringLookup using thedefault lookups
.- Type Parameters:
V
- the value type the default string lookup's map.- Parameters:
map
- the default map for string lookups.- Returns:
- a new InterpolatorStringLookup.
-
interpolatorStringLookup
Returns a new InterpolatorStringLookup using thedefault lookups
.- Parameters:
defaultStringLookup
- the default string lookup.- Returns:
- a new InterpolatorStringLookup.
-
javaPlatformStringLookup
Returns the JavaPlatformStringLookup singleton instance. Looks up keys related to Java: Java version, JRE version, VM version, and so on.The lookup keys with examples are:
- version: "Java version 1.8.0_181"
- runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"
- vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"
- os: "Windows 10 10.0, architecture: amd64-64"
- hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"
- locale: "default locale: en_US, platform encoding: iso-8859-1"
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.javaPlatformStringLookup().lookup("version");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${java:version} ..."));
The above examples convert
"version"
to the current VM version, for example,"Java version 1.8.0_181"
.- Returns:
- The JavaPlatformStringLookup singleton instance.
-
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
.
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.localHostStringLookup().lookup("canonical-name");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${localhost:canonical-name} ..."));
The above examples convert
"canonical-name"
to the current host name, for example,"EXAMPLE.apache.org"
.- Returns:
- The DateStringLookup singleton instance.
- name: for the local host name, for example
-
mapStringLookup
Returns a new map-based lookup where the request for a lookup is answered with the value for that key.- Type Parameters:
V
- the map value type.- Parameters:
map
- the map.- Returns:
- a new MapStringLookup.
-
nullStringLookup
Returns the NullStringLookup singleton instance which always returns null.- Returns:
- The NullStringLookup singleton instance.
-
propertiesStringLookup
Returns the PropertiesStringLookup singleton instance.Looks up the value for the key in the format "DocumentPath::MyKey".
Note the use of "::" instead of ":" to allow for "C:" drive letters in paths.
For example: "com/domain/document.properties::MyKey".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.propertiesStringLookup().lookup("com/domain/document.properties::MyKey");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${properties:com/domain/document.properties::MyKey} ..."));
The above examples convert
"com/domain/document.properties::MyKey"
to the key value in the properties file at the path "com/domain/document.properties".- Returns:
- The PropertiesStringLookup singleton instance.
- Since:
- 1.5
-
resourceBundleStringLookup
Returns the ResourceBundleStringLookup singleton instance.Looks up the value for a given key in the format "BundleName:BundleKey".
For example: "com.domain.messages:MyKey".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.resourceBundleStringLookup().lookup("com.domain.messages:MyKey");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${resourceBundle:com.domain.messages:MyKey} ..."));
The above examples convert
"com.domain.messages:MyKey"
to the key value in the resource bundle at"com.domain.messages"
.- Returns:
- The ResourceBundleStringLookup singleton instance.
-
resourceBundleStringLookup
Returns a ResourceBundleStringLookup instance for the given bundle name.Looks up the value for a given key in the format "MyKey".
For example: "MyKey".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.resourceBundleStringLookup("com.domain.messages").lookup("MyKey");
The above example converts
"MyKey"
to the key value in the resource bundle at"com.domain.messages"
.- Parameters:
bundleName
- Only lookup in this bundle.- Returns:
- a ResourceBundleStringLookup instance for the given bundle name.
- Since:
- 1.5
-
scriptStringLookup
Returns the ScriptStringLookup singleton instance.Looks up the value for the key in the format "ScriptEngineName:Script".
For example: "javascript:3 + 4".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.scriptStringLookup().lookup("javascript:3 + 4");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${javascript:3 + 4} ..."));
The above examples convert
"javascript:3 + 4"
to"7"
.- Returns:
- The ScriptStringLookup singleton instance.
- Since:
- 1.5
-
systemPropertyStringLookup
Returns the SystemPropertyStringLookup singleton instance where the lookup key is a system property name.Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.systemPropertyStringLookup().lookup("os.name");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${sys:os.name} ..."));
The above examples convert
"os.name"
to the operating system name.- Returns:
- The SystemPropertyStringLookup singleton instance.
-
urlDecoderStringLookup
Returns the UrlDecoderStringLookup singleton instance.Decodes URL Strings using the UTF-8 encoding.
For example: "Hello%20World%21" becomes "Hello World!".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.urlDecoderStringLookup().lookup("Hello%20World%21");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${urlDecoder:Hello%20World%21} ..."));
The above examples convert
"Hello%20World%21"
to"Hello World!"
.- Returns:
- The UrlStringLookup singleton instance.
- Since:
- 1.6
-
urlEncoderStringLookup
Returns the UrlDecoderStringLookup singleton instance.Decodes URL Strings using the UTF-8 encoding.
For example: "Hello World!" becomes "Hello+World%21".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.urlEncoderStringLookup().lookup("Hello World!");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${urlEncoder:Hello World!} ..."));
The above examples convert
"Hello World!"
to"Hello%20World%21"
.- Returns:
- The UrlStringLookup singleton instance.
- Since:
- 1.6
-
urlStringLookup
Returns the UrlStringLookup singleton instance.Looks up the value for the key in the format "CharsetName:URL".
For example, using the HTTP scheme: "UTF-8:http://www.google.com"
For example, using the file scheme: "UTF-8:file:///C:/somehome/commons/commons-text/src/test/resources/document.properties"
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.urlStringLookup().lookup("UTF-8:https://www.apache.org");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${url:UTF-8:https://www.apache.org} ..."));
The above examples convert
"UTF-8:https://www.apache.org"
to the contents of that page.- Returns:
- The UrlStringLookup singleton instance.
- Since:
- 1.5
-
xmlStringLookup
Returns the XmlStringLookup singleton instance.Looks up the value for the key in the format "DocumentPath:XPath".
For example: "com/domain/document.xml:/path/to/node".
Using a
StringLookup
from theStringLookupFactory
:StringLookupFactory.INSTANCE.xmlStringLookup().lookup("com/domain/document.xml:/path/to/node");
Using a
StringSubstitutor
:StringSubstitutor.createInterpolator().replace("... ${xml:com/domain/document.xml:/path/to/node} ..."));
The above examples convert
"com/domain/document.xml:/path/to/node"
to the value of the XPath in the XML document.- Returns:
- The XmlStringLookup singleton instance.
- Since:
- 1.5
-
base64DecoderStringLookup()
.