public final class StringLookupFactory extends Object
Modifier and Type | Field | Description |
---|---|---|
static StringLookupFactory |
INSTANCE |
Defines the singleton for this class.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addDefaultStringLookups(Map<String,StringLookup> stringLookupMap) |
The following lookups are installed:
"sys" for the
SystemPropertyStringLookup .
"env" for the EnvironmentVariableStringLookup .
"java" for the JavaPlatformStringLookup .
"date" for the DateStringLookup .
"localhost" for the LocalHostStringLookup since 1.3.
"xml" for the XmlStringLookup since 1.5.
"properties" for the PropertiesStringLookup since 1.5.
"script" for the ScriptStringLookup since 1.5.
"file" for the FileStringLookup since 1.5.
"url" for the UrlStringLookup since 1.5.
"base64" for the Base64StringLookup since 1.5.
"urlEncode" for the UrlEncoderStringLookup since 1.5.
"urlDecode" for the UrlDecoderStringLookup since 1.5.
"const" for the ConstantStringLookup since 1.5.
|
StringLookup |
base64StringLookup() |
Returns the DateStringLookup singleton instance to format the current date with the format given in the key in a
format compatible with
SimpleDateFormat . |
static void |
clear() |
Clears any static resources.
|
StringLookup |
constantStringLookup() |
Returns the ConstantStringLookup singleton instance to get the value of a fully-qualified static final value.
|
StringLookup |
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 |
environmentVariableStringLookup() |
Returns the EnvironmentVariableStringLookup singleton instance where the lookup key is an environment variable
name.
|
StringLookup |
fileStringLookup() |
Returns the FileStringLookup singleton instance.
|
StringLookup |
interpolatorStringLookup() |
Returns a new InterpolatorStringLookup.
|
StringLookup |
interpolatorStringLookup(Map<String,StringLookup> stringLookupMap,
StringLookup defaultStringLookup,
boolean addDefaultLookups) |
Returns a new InterpolatorStringLookup.
|
<V> StringLookup |
interpolatorStringLookup(Map<String,V> map) |
Returns a new InterpolatorStringLookup.
|
StringLookup |
interpolatorStringLookup(StringLookup defaultStringLookup) |
Returns a new InterpolatorStringLookup.
|
StringLookup |
javaPlatformStringLookup() |
Returns the JavaPlatformStringLookup singleton instance.
|
StringLookup |
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 |
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 |
nullStringLookup() |
Returns the NullStringLookup singleton instance which always returns null.
|
StringLookup |
propertiesStringLookup() |
Returns the PropertiesStringLookup singleton instance.
|
StringLookup |
resourceBundleStringLookup() |
Returns the ResourceBundleStringLookup singleton instance.
|
StringLookup |
resourceBundleStringLookup(String bundleName) |
Returns a ResourceBundleStringLookup instance for the given bundle name.
|
StringLookup |
scriptStringLookup() |
Returns the ScriptStringLookup singleton instance.
|
StringLookup |
systemPropertyStringLookup() |
Returns the SystemPropertyStringLookup singleton instance where the lookup key is a system property name.
|
StringLookup |
urlStringLookup() |
Returns the UrlStringLookup singleton instance.
|
StringLookup |
xmlStringLookup() |
Returns the XmlStringLookup singleton instance.
|
public static final StringLookupFactory INSTANCE
public static void clear()
public void addDefaultStringLookups(Map<String,StringLookup> stringLookupMap)
SystemPropertyStringLookup
.EnvironmentVariableStringLookup
.JavaPlatformStringLookup
.DateStringLookup
.LocalHostStringLookup
since 1.3.XmlStringLookup
since 1.5.PropertiesStringLookup
since 1.5.ScriptStringLookup
since 1.5.FileStringLookup
since 1.5.UrlStringLookup
since 1.5.Base64StringLookup
since 1.5.UrlEncoderStringLookup
since 1.5.UrlDecoderStringLookup
since 1.5.ConstantStringLookup
since 1.5.stringLookupMap
- the map of string lookups.public StringLookup base64StringLookup()
SimpleDateFormat
.public StringLookup constantStringLookup()
public StringLookup dateStringLookup()
SimpleDateFormat
.public StringLookup environmentVariableStringLookup()
public StringLookup fileStringLookup()
Looks up the value for the key in the format "CharsetName:Path".
For example: "UTF-8:com/domain/document.properties".
public StringLookup interpolatorStringLookup()
The following lookups are used by default:
SystemPropertyStringLookup
.EnvironmentVariableStringLookup
.JavaPlatformStringLookup
.DateStringLookup
.LocalHostStringLookup
, see localHostStringLookup()
for key names; since
1.3.XmlStringLookup
since 1.5.PropertiesStringLookup
since 1.5.ScriptStringLookup
since 1.5.FileStringLookup
since 1.5.UrlStringLookup
since 1.5.Base64StringLookup
since 1.5.UrlEncoderStringLookup
since 1.5.UrlDecoderStringLookup
since 1.5.ConstantStringLookup
since 1.5.public StringLookup interpolatorStringLookup(Map<String,StringLookup> stringLookupMap, StringLookup defaultStringLookup, boolean addDefaultLookups)
If addDefaultLookups
is true, the following lookups are used in addition to the ones provided in
stringLookupMap
:
SystemPropertyStringLookup
.EnvironmentVariableStringLookup
.JavaPlatformStringLookup
.DateStringLookup
.LocalHostStringLookup
, see localHostStringLookup()
for key names; since
1.3.XmlStringLookup
since 1.5.PropertiesStringLookup
since 1.5.ScriptStringLookup
since 1.5.FileStringLookup
since 1.5.UrlStringLookup
since 1.5.Base64StringLookup
since 1.5.UrlEncoderStringLookup
since 1.5.UrlDecoderStringLookup
since 1.5.ConstantStringLookup
since 1.5.stringLookupMap
- the map of string lookups.defaultStringLookup
- the default string lookup.addDefaultLookups
- whether to use lookups as described above.public <V> StringLookup interpolatorStringLookup(Map<String,V> map)
The following lookups are used by default:
SystemPropertyStringLookup
.EnvironmentVariableStringLookup
.JavaPlatformStringLookup
.DateStringLookup
.LocalHostStringLookup
, see localHostStringLookup()
for key names; since
1.3.XmlStringLookup
since 1.5.PropertiesStringLookup
since 1.5.ScriptStringLookup
since 1.5.FileStringLookup
since 1.5.UrlStringLookup
since 1.5.Base64StringLookup
since 1.5.UrlEncoderStringLookup
since 1.5.UrlDecoderStringLookup
since 1.5.ConstantStringLookup
since 1.5.V
- the value type the default string lookup's map.map
- the default map for string lookups.public StringLookup interpolatorStringLookup(StringLookup defaultStringLookup)
The following lookups are used by default:
SystemPropertyStringLookup
.EnvironmentVariableStringLookup
.JavaPlatformStringLookup
.DateStringLookup
.LocalHostStringLookup
, see localHostStringLookup()
for key names; since
1.3.XmlStringLookup
since 1.5.PropertiesStringLookup
since 1.5.ScriptStringLookup
since 1.5.FileStringLookup
since 1.5.UrlStringLookup
since 1.5.Base64StringLookup
since 1.5.UrlEncoderStringLookup
since 1.5.UrlDecoderStringLookup
since 1.5.ConstantStringLookup
since 1.5.defaultStringLookup
- the default string lookup.public StringLookup javaPlatformStringLookup()
The lookup keys with examples are:
public StringLookup localHostStringLookup()
EXAMPLE
.EXAMPLE.apache.org
.192.168.56.1
.public <V> StringLookup mapStringLookup(Map<String,V> map)
V
- the map value type.map
- the map.public StringLookup nullStringLookup()
public StringLookup propertiesStringLookup()
Looks up the value for the key in the format "DocumentPath:Key".
For example: "com/domain/document.properties:Key".
public StringLookup resourceBundleStringLookup()
Looks up the value for a given key in the format "BundleName:BundleKey".
For example: "com.domain.messages:MyKey".
public StringLookup resourceBundleStringLookup(String bundleName)
Looks up the value for a given key in the format "BundleKey".
For example: "MyKey".
bundleName
- Only lookup in this bundle.public StringLookup scriptStringLookup()
Looks up the value for the key in the format "ScriptEngineName:Script".
For example: "javascript:\"HelloWorld\"".
public StringLookup systemPropertyStringLookup()
public StringLookup urlStringLookup()
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"
public StringLookup xmlStringLookup()
Looks up the value for the key in the format "DocumentPath:XPath".
For example: "com/domain/document.xml:/path/to/node".
Copyright © 2014–2018 The Apache Software Foundation. All rights reserved.