Package org.apache.turbine.services.pull.util

Class DateTimeFormatterTool

java.lang.Object

org.apache.turbine.services.pull.util.DateTimeFormatterTool

All Implemented Interfaces:

DateTimeFormatterInterface, ApplicationTool

public class DateTimeFormatterTool
extends Object
implements ApplicationTool, DateTimeFormatterInterface

This pull tool is used to format TemporalAccessor and map(String, DateTimeFormatter, Locale) (different falvors) objects into strings. The methods may throw UnsupportedTemporalTypeException or DateTimeParseException. if the source and the target format do not match appropriately.

Constructor Summary

Constructors

Constructor	Description
DateTimeFormatterTool()

Method Summary

Modifier and Type	Method	Description
<T extends TemporalAccessor> String	format(T temporalAccessor)	Formats the given datetime as a String with the #DateTimeFormatterTool#defaultFormat.
<T extends TemporalAccessor> String	format(T temporalAccessor, String dateFormatString)	Formats the given date as a String.
<T extends TemporalAccessor> String	format(T temporalAccessor, String dateFormatString, Locale locale)	Formats the given date as a String.
String	getDateTimeFormatPattern()
DateTimeFormatter	getDefaultFormat()
DateTimeFormatterService	getDtfs()
void	init(Object data)	Initialize the application tool.
String	map(String src, String outgoingFormatPattern, Locale locale, String incomingFormatPattern)	Maps from an incoming format to an outgoing format DateTimeFormatter.
String	map(String src, DateTimeFormatter outgoingFormat, Locale locale)
String	map(String src, DateTimeFormatter outgoingFormat, Locale locale, DateTimeFormatter incomingFormat)	Uses as incoming format #defaultFormat and no locale.
String	mapFrom(String src, DateTimeFormatter incomingFormat)	Uses as incoming DateTimeFormatter #defaultFormat.
String	mapTo(String src, DateTimeFormatter outgoingFormat)	Uses as outgoing DateTimeFormatter #defaultFormat and no locale.
void	refresh()	Refresh the application tool.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeFormatterTool

public DateTimeFormatterTool()

Method Detail

init

public void init(Object data)

Initialize the application tool. The data parameter holds a different type depending on how the tool is being instantiated:

• For global tools data will be null
• For request tools data will be of type RunData
• For session and persistent tools data will be of type User

the #defaultFormat from #dateTimeFormatPattern with default Locale Locale.getDefault() and Default zone: ZoneId.systemDefault()

Specified by:

init in interface ApplicationTool

Parameters:

data - initialization data

getDtfs

public DateTimeFormatterService getDtfs()

refresh

public void refresh()

Refresh the application tool. This is necessary for development work where you probably want the tool to refresh itself if it is using configuration information that is typically cached after initialization

Specified by:

refresh in interface ApplicationTool

getDefaultFormat

public DateTimeFormatter getDefaultFormat()

Specified by:

getDefaultFormat in interface DateTimeFormatterInterface

getDateTimeFormatPattern

public String getDateTimeFormatPattern()

Specified by:

getDateTimeFormatPattern in interface DateTimeFormatterInterface

format

public <T extends TemporalAccessor> String format(T temporalAccessor)

Formats the given datetime as a String with the #DateTimeFormatterTool#defaultFormat. using the default date format.

Specified by:

format in interface DateTimeFormatterInterface

Parameters:

the - to format

Returns:

String value of the date

format

public <T extends TemporalAccessor> String format(T temporalAccessor,
                                                  String dateFormatString)

Description copied from interface: DateTimeFormatterInterface

Formats the given date as a String.

Specified by:

format in interface DateTimeFormatterInterface

dateFormatString - format string to use. See DateTimeFormatter for details.

Returns:

String value of the date

format

public <T extends TemporalAccessor> String format(T temporalAccessor,
                                                  String dateFormatString,
                                                  Locale locale)

Description copied from interface: DateTimeFormatterInterface

Formats the given date as a String.

Specified by:

format in interface DateTimeFormatterInterface

dateFormatString - format string to use. See DateTimeFormatter for details.

Returns:

String value of the date

map

public String map(String src,
                  String outgoingFormatPattern,
                  Locale locale,
                  String incomingFormatPattern)

Description copied from interface: DateTimeFormatterInterface

Maps from an incoming format to an outgoing format DateTimeFormatter.

Specified by:

map in interface DateTimeFormatterInterface

Parameters:

src - the formatted datetime

locale - Locale, if needed for outgoing formatting, no default.

Returns:

the newly mapped

map

public String map(String src,
                  DateTimeFormatter outgoingFormat,
                  Locale locale,
                  DateTimeFormatter incomingFormat)

Description copied from interface: DateTimeFormatterInterface

Uses as incoming format #defaultFormat and no locale.

Specified by:

map in interface DateTimeFormatterInterface

Returns:

the formatted string

mapTo

public String mapTo(String src,
                    DateTimeFormatter outgoingFormat)

Description copied from interface: DateTimeFormatterInterface

Uses as outgoing DateTimeFormatter #defaultFormat and no locale.

Specified by:

mapTo in interface DateTimeFormatterInterface

Parameters:

src - the datetime formatted string

Returns:

the date time formatted using the #defaultFormat.

mapFrom

public String mapFrom(String src,
                      DateTimeFormatter incomingFormat)

Description copied from interface: DateTimeFormatterInterface

Uses as incoming DateTimeFormatter #defaultFormat.

Specified by:

mapFrom in interface DateTimeFormatterInterface

Parameters:

src - the datetime formatted string

Returns:

the newly formatted date time string

map

public String map(String src,
                  DateTimeFormatter outgoingFormat,
                  Locale locale)

Specified by:

map in interface DateTimeFormatterInterface