Top Description Fields Constructors Methods
javafx.util.converter

public Class LocalDateStringConverter

extends StringConverter<LocalDate>
Class Inheritance
Imports
java.time.LocalDate, java.time.chrono.Chronology, .IsoChronology, java.time.format.DateTimeFormatter, .FormatStyle, java.util.Locale, javafx.util.StringConverter, javafx.util.converter.LocalDateTimeStringConverter.LdtConverter

StringConverter implementation for LocalDate values.

Since
JavaFX 8u40
See Also
LocalTimeStringConverter, LocalDateTimeStringConverter

Field Summary

Modifier and TypeField and Description
pack-priv LocalDateTimeStringConverter.LdtConverter<LocalDate>
ldtConverter

Constructor Summary

AccessConstructor and Description
public
LocalDateStringConverter()

Create a StringConverter for LocalDate values, using a default formatter and parser based on IsoChronology, FormatStyle#SHORT, and the user's Locale.

public
LocalDateStringConverter(FormatStyle
The FormatStyle that will be used by the default formatter and parser. If null then FormatStyle#SHORT will be used.
dateStyle)

Create a StringConverter for LocalDate values, using a default formatter and parser based on IsoChronology, the specified FormatStyle, and the user's Locale.

public
LocalDateStringConverter(DateTimeFormatter
An instance of DateTimeFormatter that will be used for formatting by the toString() method. If null then a default formatter will be used.
formatter, DateTimeFormatter
An instance of DateTimeFormatter that will be used for parsing by the fromString() method. This can be identical to formatter. If null then formatter will be used, and if that is also null, then a default parser will be used.
parser)

Create a {#link StringConverter} for LocalDate values using the supplied formatter and parser.

public
LocalDateStringConverter(FormatStyle
The FormatStyle that will be used by the default formatter and parser. If null then FormatStyle#SHORT will be used.
dateStyle, Locale
The Locale that will be used by the default formatter and parser. If null then Locale.getDefault(Locale.Category.FORMAT) will be used.
locale, Chronology
The Chronology that will be used by the default formatter and parser. If null then IsoChronology#INSTANCE will be used.
chronology)

Create a StringConverter for LocalDate values using a default formatter and parser, which will be based on the supplied FormatStyle, Locale, and Chronology.

Method Summary

Modifier and TypeMethod and Description
public LocalDate
fromString(String
the String to convert
value)

Implements abstract javafx.util.StringConverter.fromString.

Converts the string provided into an object defined by the specific converter.

public String
toString(LocalDate
the object of type T to convert
value)

Implements abstract javafx.util.StringConverter.toString.

Converts the object provided into its string form.

Field Detail

ldtConverterback to summary
pack-priv LocalDateTimeStringConverter.LdtConverter<LocalDate> ldtConverter

Constructor Detail

LocalDateStringConverterback to summary
public LocalDateStringConverter()

Create a StringConverter for LocalDate values, using a default formatter and parser based on IsoChronology, FormatStyle#SHORT, and the user's Locale.

This converter ensures symmetry between the toString() and fromString() methods. Many of the default locale based patterns used by DateTimeFormatter will display only two digits for the year when formatting to a string. This would cause a value like 1955 to be displayed as 55, which in turn would be parsed back as 2055. This converter modifies two-digit year patterns to always use four digits. The input parsing is not affected, so two digit year values can still be parsed leniently as expected in these locales.

LocalDateStringConverterback to summary
public LocalDateStringConverter(FormatStyle dateStyle)

Create a StringConverter for LocalDate values, using a default formatter and parser based on IsoChronology, the specified FormatStyle, and the user's Locale.

Parameters
dateStyle:FormatStyle

The FormatStyle that will be used by the default formatter and parser. If null then FormatStyle#SHORT will be used.

LocalDateStringConverterback to summary
public LocalDateStringConverter(DateTimeFormatter formatter, DateTimeFormatter parser)

Create a {#link StringConverter} for LocalDate values using the supplied formatter and parser.

For example, to use a fixed pattern for converting both ways:

String pattern = "yyyy-MM-dd";
DateTimeFormatter formatter = DateTimeFormatter.ofPattern(pattern);
StringConverter<LocalDate> converter =
    DateTimeStringConverter.getLocalDateStringConverter(formatter, null);
Note that the formatter and parser can be created to handle non-default Locale and Chronology as needed.
Parameters
formatter:DateTimeFormatter

An instance of DateTimeFormatter that will be used for formatting by the toString() method. If null then a default formatter will be used.

parser:DateTimeFormatter

An instance of DateTimeFormatter that will be used for parsing by the fromString() method. This can be identical to formatter. If null then formatter will be used, and if that is also null, then a default parser will be used.

LocalDateStringConverterback to summary
public LocalDateStringConverter(FormatStyle dateStyle, Locale locale, Chronology chronology)

Create a StringConverter for LocalDate values using a default formatter and parser, which will be based on the supplied FormatStyle, Locale, and Chronology.

Parameters
dateStyle:FormatStyle

The FormatStyle that will be used by the default formatter and parser. If null then FormatStyle#SHORT will be used.

locale:Locale

The Locale that will be used by the default formatter and parser. If null then Locale.getDefault(Locale.Category.FORMAT) will be used.

chronology:Chronology

The Chronology that will be used by the default formatter and parser. If null then IsoChronology#INSTANCE will be used.

Method Detail

fromStringback to summary
public LocalDate fromString(String value)

Implements abstract javafx.util.StringConverter.fromString.

Doc from javafx.util.StringConverter.fromString.

Converts the string provided into an object defined by the specific converter. Format of the string and type of the resulting object is defined by the specific converter.

Parameters
value:String

the String to convert

Returns:LocalDate

an object representation of the string passed in.

Annotations
@Override
toStringback to summary
public String toString(LocalDate value)

Implements abstract javafx.util.StringConverter.toString.

Doc from javafx.util.StringConverter.toString.

Converts the object provided into its string form. Format of the returned string is defined by the specific converter.

Parameters
value:LocalDate

the object of type T to convert

Returns:String

a string representation of the object passed in

Annotations
@Override