scheme

Class DateTimeFormats

java.lang.Object

scheme.DateTimeFormats

public class DateTimeFormats
extends Object

Utility class for working with date-time formats within scheme.

Method Summary

Modifier and Type	Method and Description
static boolean	add(Locale locale, String format) Adds the specified format to the list of recognised date-time formats.
static List<DateTimeFormatter>	get() Returns all known date-time formats as an unmodifiableList of DateTimeFormatters.
static Optional<DateTimeFormatter>	remove(int index) Removes the specified format from the list of recognized date-time formats, if it exists.
static List<String>	strings() Returns all known date-time formats as an unmodifiableList of Strings.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static List<DateTimeFormatter> get()

Returns all known date-time formats as an unmodifiableList of DateTimeFormatters.

Returns:

all known date-time formats as an unmodifiableList of DateTimeFormatters.

strings

public static List<String> strings()

Returns all known date-time formats as an unmodifiableList of Strings.

Returns:

all known date-time formats as an unmodifiableList of Strings.

add

public static boolean add(Locale locale,
                          String format)

Adds the specified format to the list of recognised date-time formats.

locale must be a valid Locale, e.g. "en_US".

format must be a valid DateTimeFormatter-styled date-time format, e.g. "MM/dd/yyyy HH:mm".

Parameters:

locale - the Locale of this date-time format

format - a String representation of this date-time format

Returns:

true if format was successfully added to list of recognised formats, false otherwise

remove

public static Optional<DateTimeFormatter> remove(int index)

Removes the specified format from the list of recognized date-time formats, if it exists.

Formats are removed according to their indices. Note that the first format is at index 0, which means that, for a list of N formats, the last format has index N-1.

The formats returned from get() and strings() are returned in order, by their indices.

Parameters:

index - index of the date-time format to remove

Returns:

the removed format as a DateTimeFormatter object, wrapped in an Optional; returns an empty Optional if the index is out of range.

See Also:

strings() returns an ordered list of the currently-recognized date-time formats