de.xima.fc.appointment

Class JQueryDatePickerFormat

java.lang.Object

de.xima.fc.appointment.JQueryDatePickerFormat

@Immutable
public class JQueryDatePickerFormat
extends Object

Parse and format dates as implemented by the JQuery date picker https://api.jqueryui.com/datepicker/#utility-parseDate. Instances are immutable and thread safe.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
void	assertValidParseFormat() Same as isValidParseFormat(), but throws if it is not valid.
String	format(Instant instant, ZoneId zoneId) Formats the given instant in the given time zone according to the settings of this instance.
String	format(LocalDate date, ZoneId zoneId) Formats the given instant in the given time zone according to the settings of this instance.
String	format(ZonedDateTime dateTime) Formats the given instant in the given time zone according to the settings of this instance.
String	getFormatString()
boolean	isValidParseFormat()
ZonedDateTime	parse(String dateToParse, ZoneId zoneId) Parses a date string with the current options.
Instant	parseInstant(String dateToParse, ZoneId zoneId) Parses a date string with the current options.
static JQueryDatePickerFormat	withJsonConfig(com.alibaba.fastjson.JSONObject json, String formatString) Creates a new JQuery datepicker format for the given locale and format string.
static JQueryDatePickerFormat	withLocale(Locale locale, String formatString) Creates a new JQuery datepicker format for the given locale and format string.

Methods inherited from class java.lang.Object

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

Method Detail

assertValidParseFormat

public void assertValidParseFormat()
                            throws IllegalStateException

Same as isValidParseFormat(), but throws if it is not valid.

Throws:

IllegalStateException - When the format is not valid for parsing.

format

public String format(Instant instant,
                     ZoneId zoneId)

Formats the given instant in the given time zone according to the settings of this instance.

Parameters:

instant - Instance to format.

zoneId - Time zone to use for time zone dependent fields.

Returns:

The formatted date.

format

public String format(LocalDate date,
                     ZoneId zoneId)

Formats the given instant in the given time zone according to the settings of this instance.

Parameters:

date - Date to format.

zoneId - Time zone to use for time zone dependent fields.

Returns:

The formatted date.

format

public String format(ZonedDateTime dateTime)

Formats the given instant in the given time zone according to the settings of this instance.

Parameters:

dateTime - The date time to format.

Returns:

The formatted date.

getFormatString

public String getFormatString()

Returns:

The format string that is used by this instance.

isValidParseFormat

public boolean isValidParseFormat()

Returns:

Whether the format is valid for parsing a date, e.g. contains enough data to construct a date. If this returns false, parse(String, ZoneId) will throw an exception. so make sure to check beforehand.

parse

public ZonedDateTime parse(String dateToParse,
                           ZoneId zoneId)
                    throws DateTimeException,
                           IllegalArgumentException

Parses a date string with the current options.

Parameters:

dateToParse - A date string to parse.

zoneId - Time zone to use.

Returns:

The parsed date.

Throws:

DateTimeException - When the date to parse is semantically invalid (such as when the month or day is out of range).

IllegalArgumentException - When the date to parse is syntactically invalid.

IllegalStateException - When isValidParseFormat() returns false.

parseInstant

public Instant parseInstant(String dateToParse,
                            ZoneId zoneId)

Parses a date string with the current options.

Parameters:

dateToParse - A date string to parse.

zoneId - Time zone to use.

Returns:

The parsed date as an instant

withJsonConfig

public static JQueryDatePickerFormat withJsonConfig(com.alibaba.fastjson.JSONObject json,
                                                    String formatString)

Creates a new JQuery datepicker format for the given locale and format string. It is immutable and thread safe.

Parameters:

json - JSON with day and month names to use, in the format as defined by the JQuery datepicker.

formatString - Format string to use.

Returns:

A new date picker format with the given options.

withLocale

public static JQueryDatePickerFormat withLocale(Locale locale,
                                                String formatString)

Creates a new JQuery datepicker format for the given locale and format string. It is immutable and thread safe.

Parameters:

locale - Locale to use.

formatString - Format string to use.

Returns:

A new date picker format with the given options.