Package org.apache.commons.text.lookup
Class DateStringLookup
java.lang.Object
org.apache.commons.text.lookup.AbstractStringLookup
org.apache.commons.text.lookup.DateStringLookup
- All Implemented Interfaces:
StringLookup
Formats the current date with the format given in the key in a format compatible with
SimpleDateFormat
.
Using a StringLookup
from the StringLookupFactory
:
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 today's date, for example, "2019-08-04"
.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final DateStringLookup
Defines the singleton for this class.Fields inherited from class org.apache.commons.text.lookup.AbstractStringLookup
SPLIT_CH, SPLIT_STR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate String
formatDate
(long dateMillis, String format) Formats the givendate
long with the givenformat
.Formats the current date with the format given in the key in a format compatible withSimpleDateFormat
.Methods inherited from class org.apache.commons.text.lookup.AbstractStringLookup
substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey
-
Field Details
-
INSTANCE
Defines the singleton for this class.
-
-
Constructor Details
-
DateStringLookup
private DateStringLookup()No need to build instances for now.
-
-
Method Details
-
formatDate
Formats the givendate
long with the givenformat
.- Parameters:
dateMillis
- the date to formatformat
- the format string forSimpleDateFormat
.- Returns:
- The formatted date
-
lookup
Formats the current date with the format given in the key in a format compatible withSimpleDateFormat
.- Parameters:
key
- the format to use. If null, the defaultDateFormat
will be used.- Returns:
- The value of the environment variable.
-