Top Description Fields Constructors Methods
org.apache.commons.text.lookup

public final Enum DefaultStringLookup

extends Enum<DefaultStringLookup>
Class Inheritance
An enumeration defining StringLookup objects available through StringLookupFactory.

This enum was adapted and expanded from Apache Commons Configuration 2.4.

Note

Starting in version 1.10.0, not all lookups defined in this class are included by default in the StringLookupFactory.addDefaultStringLookups method. See the StringLookupFactory class documentation for details.

Since
1.7
See Also
StringLookupFactory, StringLookup

Field Summary

Modifier and TypeField and Description
public static final DefaultStringLookup
BASE64_DECODER

The lookup for Base64 decoding using the key "base64Decoder".

public static final DefaultStringLookup
BASE64_ENCODER

The lookup for Base64 encoding using the key "base64Encoder".

public static final DefaultStringLookup
CONST

The lookup for Java static class member constants using the key "const".

public static final DefaultStringLookup
DATE

The lookup for formatting the current date using the key "date".

public static final DefaultStringLookup
DNS

The lookup for DNS using the key "dns".

public static final DefaultStringLookup
ENVIRONMENT

The lookup for environment properties using the key "env".

public static final DefaultStringLookup
FILE

The lookup for files using the key "file".

public static final DefaultStringLookup
JAVA

The lookup for Java platform information using the key "java".

private final String
key

The prefix under which the associated lookup object is registered.

public static final DefaultStringLookup
LOCAL_HOST

The lookup for local host information using the key "localhost".

private final StringLookup
lookup

The associated lookup instance.

public static final DefaultStringLookup
LOOPBACK_ADDRESS

The lookup for local host information using the key "loopbackAddress".

public static final DefaultStringLookup
PROPERTIES

The lookup for properties using the key "properties".

public static final DefaultStringLookup
RESOURCE_BUNDLE

The lookup for resource bundles using the key "resourceBundle".

public static final DefaultStringLookup
SCRIPT

The lookup for scripts using the key "script".

public static final DefaultStringLookup
SYSTEM_PROPERTIES

The lookup for system properties using the key "sys".

public static final DefaultStringLookup
URL

The lookup for URLs using the key "url".

public static final DefaultStringLookup
URL_DECODER

The lookup for URL decoding using the key "urlDecoder".

public static final DefaultStringLookup
URL_ENCODER

The lookup for URL encoding using the key "urlEncoder".

public static final DefaultStringLookup
XML

The lookup for XML decoding using the key "xml".

public static final DefaultStringLookup
XML_DECODER

The lookup for XML decoding using the key "xmlDecoder".

public static final DefaultStringLookup
XML_ENCODER

The lookup for XML encoding using the key "xmlEncoder".

Constructor Summary

AccessConstructor and Description
private
DefaultStringLookup(final String
the prefix
prefix, final StringLookup
the StringLookup instance
lookup)

Constructs a new instance of DefaultStringLookup and sets the key and the associated lookup instance.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the prefix
getKey()

Gets the standard prefix for the lookup object of this kind.

public StringLookup

Returns:

the associated StringLookup object
getStringLookup()

Gets the standard StringLookup instance of this kind.

public static DefaultStringLookup
valueOf(String name)

public static DefaultStringLookup[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BASE64_DECODERback to summary
public static final DefaultStringLookup BASE64_DECODER

The lookup for Base64 decoding using the key "base64Decoder".

See Also
StringLookupFactory#KEY_BASE64_DECODER, StringLookupFactory#base64DecoderStringLookup()
BASE64_ENCODERback to summary
public static final DefaultStringLookup BASE64_ENCODER

The lookup for Base64 encoding using the key "base64Encoder".

See Also
StringLookupFactory#KEY_BASE64_ENCODER, StringLookupFactory#base64EncoderStringLookup()
CONSTback to summary
public static final DefaultStringLookup CONST

The lookup for Java static class member constants using the key "const".

See Also
StringLookupFactory#KEY_CONST, StringLookupFactory#constantStringLookup()
DATEback to summary
public static final DefaultStringLookup DATE

The lookup for formatting the current date using the key "date".

See Also
StringLookupFactory#KEY_DATE, StringLookupFactory#dateStringLookup()
DNSback to summary
public static final DefaultStringLookup DNS

The lookup for DNS using the key "dns".

Since
1.8
See Also
StringLookupFactory#KEY_DNS, StringLookupFactory#dnsStringLookup()
ENVIRONMENTback to summary
public static final DefaultStringLookup ENVIRONMENT

The lookup for environment properties using the key "env".

See Also
StringLookupFactory#KEY_ENV, StringLookupFactory#environmentVariableStringLookup()
FILEback to summary
public static final DefaultStringLookup FILE

The lookup for files using the key "file".

See Also
StringLookupFactory#KEY_FILE, StringLookupFactory#fileStringLookup()
JAVAback to summary
public static final DefaultStringLookup JAVA

The lookup for Java platform information using the key "java".

See Also
StringLookupFactory#KEY_JAVA, StringLookupFactory#javaPlatformStringLookup()
keyback to summary
private final String key

The prefix under which the associated lookup object is registered.

LOCAL_HOSTback to summary
public static final DefaultStringLookup LOCAL_HOST

The lookup for local host information using the key "localhost".

See Also
StringLookupFactory#KEY_LOCALHOST, StringLookupFactory#localHostStringLookup()
lookupback to summary
private final StringLookup lookup

The associated lookup instance.

LOOPBACK_ADDRESSback to summary
public static final DefaultStringLookup LOOPBACK_ADDRESS

The lookup for local host information using the key "loopbackAddress".

See Also
StringLookupFactory#KEY_LOOPBACK_ADDRESS, StringLookupFactory#loopbackAddressStringLookup()
PROPERTIESback to summary
public static final DefaultStringLookup PROPERTIES

The lookup for properties using the key "properties".

See Also
StringLookupFactory#KEY_PROPERTIES, StringLookupFactory#propertiesStringLookup()
RESOURCE_BUNDLEback to summary
public static final DefaultStringLookup RESOURCE_BUNDLE

The lookup for resource bundles using the key "resourceBundle".

See Also
StringLookupFactory#KEY_RESOURCE_BUNDLE, StringLookupFactory#resourceBundleStringLookup()
SCRIPTback to summary
public static final DefaultStringLookup SCRIPT

The lookup for scripts using the key "script".

See Also
StringLookupFactory#KEY_SCRIPT, StringLookupFactory#scriptStringLookup()
SYSTEM_PROPERTIESback to summary
public static final DefaultStringLookup SYSTEM_PROPERTIES

The lookup for system properties using the key "sys".

See Also
StringLookupFactory#KEY_SYS, StringLookupFactory#systemPropertyStringLookup()
URLback to summary
public static final DefaultStringLookup URL

The lookup for URLs using the key "url".

See Also
StringLookupFactory#KEY_URL, StringLookupFactory#urlStringLookup()
URL_DECODERback to summary
public static final DefaultStringLookup URL_DECODER

The lookup for URL decoding using the key "urlDecoder".

See Also
StringLookupFactory#KEY_URL_DECODER, StringLookupFactory#urlDecoderStringLookup()
URL_ENCODERback to summary
public static final DefaultStringLookup URL_ENCODER

The lookup for URL encoding using the key "urlEncoder".

See Also
StringLookupFactory#KEY_URL_ENCODER, StringLookupFactory#urlEncoderStringLookup()
XMLback to summary
public static final DefaultStringLookup XML

The lookup for XML decoding using the key "xml".

See Also
StringLookupFactory#KEY_XML, StringLookupFactory#xmlStringLookup()
XML_DECODERback to summary
public static final DefaultStringLookup XML_DECODER

The lookup for XML decoding using the key "xmlDecoder".

Since
1.11.0
See Also
StringLookupFactory#KEY_XML_DECODER, StringLookupFactory#xmlDecoderStringLookup()
XML_ENCODERback to summary
public static final DefaultStringLookup XML_ENCODER

The lookup for XML encoding using the key "xmlEncoder".

Since
1.11.0
See Also
StringLookupFactory#KEY_XML_ENCODER, StringLookupFactory#xmlEncoderStringLookup()

Constructor Detail

DefaultStringLookupback to summary
private DefaultStringLookup(final String prefix, final StringLookup lookup)

Constructs a new instance of DefaultStringLookup and sets the key and the associated lookup instance.

Parameters
prefix:String

the prefix

lookup:StringLookup

the StringLookup instance

Method Detail

getKeyback to summary
public String getKey()

Gets the standard prefix for the lookup object of this kind.

Returns:String

the prefix

getStringLookupback to summary
public StringLookup getStringLookup()

Gets the standard StringLookup instance of this kind.

Returns:StringLookup

the associated StringLookup object

valueOfback to summary
public static DefaultStringLookup valueOf(String name)
valuesback to summary
public static DefaultStringLookup[] values()