play.data.format

Class Formats.DateFormatter

java.lang.Object

play.data.format.Formatters.SimpleFormatter<java.util.Date>

play.data.format.Formats.DateFormatter

Enclosing class:

Formats

public static class Formats.DateFormatter
extends Formatters.SimpleFormatter<java.util.Date>

Formatter for java.util.Date values.

Constructor Summary

Constructors

Constructor and Description
DateFormatter(MessagesApi messagesApi) Creates a date formatter.
DateFormatter(MessagesApi messagesApi, java.lang.String pattern) Creates a date formatter.
DateFormatter(MessagesApi messagesApi, java.lang.String pattern, java.lang.String patternNoApp) Creates a date formatter.

Method Summary

Modifier and Type	Method and Description
java.util.Date	parse(java.lang.String text, java.util.Locale locale) Binds the field - constructs a concrete value from submitted data.
java.lang.String	print(java.util.Date value, java.util.Locale locale) Unbinds this fields - converts a concrete value to a plain string.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFormatter

public DateFormatter(MessagesApi messagesApi)

Creates a date formatter. The value defined for the message file key "formats.date" will be used as the default pattern.

Parameters:

messagesApi - messages to look up the pattern

DateFormatter

public DateFormatter(MessagesApi messagesApi,
                     java.lang.String pattern)

Creates a date formatter.

Parameters:

messagesApi - messages to look up the pattern

pattern - date pattern, as specified for SimpleDateFormat. Can be a message file key.

DateFormatter

public DateFormatter(MessagesApi messagesApi,
                     java.lang.String pattern,
                     java.lang.String patternNoApp)

Creates a date formatter.

Parameters:

messagesApi - messages to look up the pattern

pattern - date pattern, as specified for SimpleDateFormat. Can be a message file key.

patternNoApp - date pattern to use as fallback when no app is started.

Method Detail

parse

public java.util.Date parse(java.lang.String text,
                            java.util.Locale locale)
                     throws java.text.ParseException

Binds the field - constructs a concrete value from submitted data.

Specified by:

parse in class Formatters.SimpleFormatter<java.util.Date>

Parameters:

text - the field text

locale - the current Locale

Returns:

a new value

Throws:

java.text.ParseException - if the text could not be parsed into T

print

public java.lang.String print(java.util.Date value,
                              java.util.Locale locale)

Unbinds this fields - converts a concrete value to a plain string.

Specified by:

print in class Formatters.SimpleFormatter<java.util.Date>

Parameters:

value - the value to unbind

locale - the current Locale

Returns:

printable version of the value