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

final class DateStringLookup
extends AbstractStringLookup

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

Fields

Modifier and Type	Field	Description
(package private) static DateStringLookup	INSTANCE	Defines the singleton for this class.

Fields inherited from class org.apache.commons.text.lookup.AbstractStringLookup

SPLIT_CH, SPLIT_STR

Method Summary

Modifier and Type	Method	Description
String	lookup(String key)	Formats the current date with the format given in the key in a format compatible with SimpleDateFormat.

Methods inherited from class org.apache.commons.text.lookup.AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

static final DateStringLookup INSTANCE

Defines the singleton for this class.

Method Detail

lookup

public String lookup(String key)

Formats the current date with the format given in the key in a format compatible with SimpleDateFormat.

Parameters:

key - the format to use. If null, the default DateFormat will be used.

Returns:

The value of the environment variable.