org.pojava.datetime

Class DateTimeConfig

java.lang.Object

org.pojava.datetime.DateTimeConfig

All Implemented Interfaces:

Serializable, IDateTimeConfig

public class DateTimeConfig
extends Object
implements IDateTimeConfig, Serializable

Establish global defaults for shaping DateTime behavior. This version supports English, German, French and Spanish month names in the date parser, and can be customized by your applications to interpret other languages.

Author:

John Pile

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateTimeConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTzMap(Map<String,String> tzMap) Merge a Map of time zones recognized by DateTime
static DateTimeConfig	fromBuilder(DateTimeConfigBuilder builder)
String	getBcPrefix()
String	getDefaultJdbcFormat() Get the default JDBC date format.
int	getEpochDOW() Get the day of week offset on the epoch date.
String	getFormat() Get the default date format.
static IDateTimeConfig	getGlobalDefault()
TimeZone	getInputTimeZone()
Locale	getLocale() Locale under which toString words are translated
TimeZone	getOutputTimeZone()
Map<String,String>	getTzMap() Map of timezones and their offsets.
boolean	isDmyOrder() Returns true if 01/02/1970 is interpreted as 1970-02-01, returns false if 01/02/1970 is interpreted as 1970-01-02.
boolean	isUnspecifiedCenturyAlwaysInPast()
Integer	lookupMonthIndex(String monthNameOrAbbreviation)
TimeZone	lookupTimeZone(String id)
TimeZone	lookupTimeZone(String id, TimeZone defaultTimeZone) Lookup the TimeZone, including custom time zones.
static void	setGlobalDefault(IDateTimeConfig globalDefault) Reset the global default to a different DateTimeConfig object.
static void	setGlobalDefaultFromBuilder(DateTimeConfigBuilder builder)
long	systemTime()
void	validate() Ensure that object is complete and consistent

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeConfig

public DateTimeConfig()

Method Detail

setGlobalDefault

public static void setGlobalDefault(IDateTimeConfig globalDefault)

Reset the global default to a different DateTimeConfig object.

Parameters:

globalDefault - Set this DateTimeConfig instance as the global default.

getGlobalDefault

public static IDateTimeConfig getGlobalDefault()

Returns:

The singleton used as the default DateTimeConfig.

isDmyOrder

public boolean isDmyOrder()

Returns true if 01/02/1970 is interpreted as 1970-02-01, returns false if 01/02/1970 is interpreted as 1970-01-02.

Specified by:

isDmyOrder in interface IDateTimeConfig

Returns:

True if DD/MM/YYYY is recognized by parser over MM/DD/YYYY.

getTzMap

public Map<String,String> getTzMap()

Description copied from interface: IDateTimeConfig

Map of timezones and their offsets. You can customize the default map to add your own timezones by referencing other timezones.

Specified by:

getTzMap in interface IDateTimeConfig

Returns:

a Map of time zones recognized by DateTime.

addTzMap

public void addTzMap(Map<String,String> tzMap)

Merge a Map of time zones recognized by DateTime

Parameters:

tzMap - A map of custom time zone ids to TimeZone objects

validate

public void validate()

Ensure that object is complete and consistent

Specified by:

validate in interface IDateTimeConfig

getEpochDOW

public int getEpochDOW()

Get the day of week offset on the epoch date. This is used to calculate the day of week for all other dates.

Specified by:

getEpochDOW in interface IDateTimeConfig

Returns:

Day of week offset of the epoch date.

getFormat

public String getFormat()

Get the default date format.

Specified by:

getFormat in interface IDateTimeConfig

Returns:

A format string for dates.

getDefaultJdbcFormat

public String getDefaultJdbcFormat()

Get the default JDBC date format.

Returns:

the default format desired for JDBC.

lookupTimeZone

public TimeZone lookupTimeZone(String id)

Specified by:

lookupTimeZone in interface IDateTimeConfig

lookupTimeZone

public TimeZone lookupTimeZone(String id,
                      TimeZone defaultTimeZone)

Lookup the TimeZone, including custom time zones.

Specified by:

lookupTimeZone in interface IDateTimeConfig

lookupMonthIndex

public Integer lookupMonthIndex(String monthNameOrAbbreviation)

Specified by:

lookupMonthIndex in interface IDateTimeConfig

getInputTimeZone

public TimeZone getInputTimeZone()

Specified by:

getInputTimeZone in interface IDateTimeConfig

Returns:

Input TimeZone default for parser.

getOutputTimeZone

public TimeZone getOutputTimeZone()

Specified by:

getOutputTimeZone in interface IDateTimeConfig

Returns:

Default TimeZone for DateTime.toString formatter.

getLocale

public Locale getLocale()

Locale under which toString words are translated

Specified by:

getLocale in interface IDateTimeConfig

isUnspecifiedCenturyAlwaysInPast

public boolean isUnspecifiedCenturyAlwaysInPast()

Specified by:

isUnspecifiedCenturyAlwaysInPast in interface IDateTimeConfig

Returns:

When true, a date missing century is always assumed to be a past date

getBcPrefix

public String getBcPrefix()

Specified by:

getBcPrefix in interface IDateTimeConfig

systemTime

public long systemTime()

Specified by:

systemTime in interface IDateTimeConfig

setGlobalDefaultFromBuilder

public static void setGlobalDefaultFromBuilder(DateTimeConfigBuilder builder)

fromBuilder

public static DateTimeConfig fromBuilder(DateTimeConfigBuilder builder)