Package org.apache.commons.text.lookup
Enum Class DefaultStringLookup
- All Implemented Interfaces:
Serializable
,Comparable<DefaultStringLookup>
,Constable
An enumeration defining
StringLookup
objects available through StringLookupFactory
.
This enum was adapted and expanded from Apache Commons Configuration 2.4.
- Since:
- 1.7
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe lookup for Base64 decoding using the key "base64Decoder".The lookup for Base64 decoding using the key "base64Encoder".The lookup for constants using the key "const".The lookup for dates using the key "date".The lookup for DNS using the key "dns".The lookup for environment properties using the key "env".The lookup for files using the key "file".The lookup for Java platform information using the key "java".The lookup for localhost information using the key "localhost".The lookup for properties using the key "properties".The lookup for resource bundles using the key "resourceBundle".The lookup for scripts using the key "script".The lookup for system properties using the key "sys".The lookup for URLs using the key "url".The lookup for URL decoding using the key "urlDecoder".The lookup for URL decoding using the key "urlEncoder".The lookup for URL decoding using the key "xml". -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
The prefix under which the associated lookup object is registered.private final StringLookup
The associated lookup instance. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
DefaultStringLookup
(String prefix, StringLookup lookup) Creates a new instance ofDefaultStringLookup
and sets the key and the associated lookup instance. -
Method Summary
Modifier and TypeMethodDescriptiongetKey()
Returns the standard prefix for the lookup object of this kind.Returns the standardStringLookup
instance of this kind.static DefaultStringLookup
Returns the enum constant of this class with the specified name.static DefaultStringLookup[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
BASE64_DECODER
The lookup for Base64 decoding using the key "base64Decoder". -
BASE64_ENCODER
The lookup for Base64 decoding using the key "base64Encoder". -
CONST
The lookup for constants using the key "const". -
DATE
The lookup for dates using the key "date". -
DNS
The lookup for DNS using the key "dns".- Since:
- 1.8
-
ENVIRONMENT
The lookup for environment properties using the key "env". -
FILE
The lookup for files using the key "file". -
JAVA
The lookup for Java platform information using the key "java". -
LOCAL_HOST
The lookup for localhost information using the key "localhost". -
PROPERTIES
The lookup for properties using the key "properties". -
RESOURCE_BUNDLE
The lookup for resource bundles using the key "resourceBundle". -
SCRIPT
The lookup for scripts using the key "script". -
SYSTEM_PROPERTIES
The lookup for system properties using the key "sys". -
URL
The lookup for URLs using the key "url". -
URL_DECODER
The lookup for URL decoding using the key "urlDecoder". -
URL_ENCODER
The lookup for URL decoding using the key "urlEncoder". -
XML
The lookup for URL decoding using the key "xml".
-
-
Field Details
-
key
The prefix under which the associated lookup object is registered. -
lookup
The associated lookup instance.
-
-
Constructor Details
-
DefaultStringLookup
Creates a new instance ofDefaultStringLookup
and sets the key and the associated lookup instance.- Parameters:
prefix
- the prefixlookup
- theStringLookup
instance
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getKey
Returns the standard prefix for the lookup object of this kind.- Returns:
- the prefix
-
getStringLookup
Returns the standardStringLookup
instance of this kind.- Returns:
- the associated
StringLookup
object
-