Modifier and Type	Class and Description
private static class	AbstractFormatCache.ArrayKey Helper class to hold multipart Map keys as arrays.

Modifier and Type	Field and Description
private static final ConcurrentMap<AbstractFormatCache.ArrayKey, String>	dateTimeInstanceCache
private final ConcurrentMap<AbstractFormatCache.ArrayKey, F>	instanceCache
pack-priv static final int	NONE No date or no time.

Access	Constructor and Description
pack-priv	AbstractFormatCache()

Method Summary

Modifier and Type	Method and Description
pack-priv static void	clear() Clears the cache.
pack-priv void	clearInstance() Clears the cache.
protected abstract F	Returns: a pattern based date/time formatter. createInstance(String `java.text.SimpleDateFormat` compatible pattern, this will not be null. pattern, TimeZone time zone, this will not be null. timeZone, Locale locale, this will not be null. locale) Create a format instance using the specified pattern, time zone and locale.
pack-priv F	Returns: a localized standard date/time formatter. getDateInstance(final int date style: FULL, LONG, MEDIUM, or SHORT. dateStyle, final TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. timeZone, final Locale optional locale, overrides system locale. locale) Gets a date formatter instance using the specified style, time zone and locale.
pack-priv F	Returns: a localized standard date/time formatter. getDateTimeInstance(final int date style: FULL, LONG, MEDIUM, or SHORT. dateStyle, final int time style: FULL, LONG, MEDIUM, or SHORT. timeStyle, final TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. timeZone, final Locale optional locale, overrides system locale. locale) Gets a date/time formatter instance using the specified style, time zone and locale.
private F	Returns: a localized standard date/time formatter. getDateTimeInstance(final Integer date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format. dateStyle, final Integer time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format. timeStyle, final TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. timeZone, Locale optional locale, overrides system locale. locale) Gets a date/time formatter instance using the specified style, time zone and locale.
public F	Returns: a date/time formatter. getInstance() Gets a formatter instance using the default pattern in the default time zone and locale.
public F	Returns: a pattern based date/time formatter. getInstance(final String `java.text.SimpleDateFormat` compatible pattern, non-null. pattern, final TimeZone the time zone, null means use the default TimeZone. timeZone, final Locale the locale, null means use the default Locale. locale) Gets a formatter instance using the specified pattern, time zone and locale.
pack-priv static String	Returns: a localized standard date/time format. getPatternForStyle(final Integer date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format. dateStyle, final Integer time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format. timeStyle, final Locale The non-null locale of the desired format. locale) Gets a date/time format for the specified styles and locale.
pack-priv F	Returns: a localized standard date/time formatter. getTimeInstance(final int time style: FULL, LONG, MEDIUM, or SHORT. timeStyle, final TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. timeZone, final Locale optional locale, overrides system locale. locale) Gets a time formatter instance using the specified style, time zone and locale.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dateTimeInstanceCache	back to summary
private static final ConcurrentMap<AbstractFormatCache.ArrayKey, String> dateTimeInstanceCache

instanceCache	back to summary
private final ConcurrentMap<AbstractFormatCache.ArrayKey, F> instanceCache

NONE	back to summary
pack-priv static final int NONE No date or no time. Used in same parameters as DateFormat.SHORT or DateFormat.LONG.

AbstractFormatCache	back to summary
pack-priv AbstractFormatCache()

Method Detail

clear	back to summary
pack-priv static void clear() Clears the cache.

clearInstance	back to summary
pack-priv void clearInstance() Clears the cache.

createInstance back to summary

createInstance	back to summary
protected abstract F createInstance(String pattern, TimeZone timeZone, Locale locale) Create a format instance using the specified pattern, time zone and locale. Parameters pattern:String `java.text.SimpleDateFormat` compatible pattern, this will not be null. timeZone:TimeZone time zone, this will not be null. locale:Locale locale, this will not be null. Returns:F a pattern based date/time formatter. Exceptions IllegalArgumentException: if pattern is invalid or `null`.

protected abstract F createInstance(String pattern, TimeZone timeZone, Locale locale)

Create a format instance using the specified pattern, time zone and locale.

Parameters

pattern:String: java.text.SimpleDateFormat compatible pattern, this will not be null.
timeZone:TimeZone: time zone, this will not be null.
locale:Locale: locale, this will not be null.

Returns:F

a pattern based date/time formatter.

Exceptions

IllegalArgumentException:: if pattern is invalid or null.

getDateInstance	back to summary
pack-priv F getDateInstance(final int dateStyle, final TimeZone timeZone, final Locale locale) Gets a date formatter instance using the specified style, time zone and locale. Parameters dateStyle:int date style: FULL, LONG, MEDIUM, or SHORT. timeZone:TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. locale:Locale optional locale, overrides system locale. Returns:F a localized standard date/time formatter. Exceptions IllegalArgumentException: if the Locale has no date/time pattern defined.

getDateInstance

back to summary

pack-priv F getDateInstance(final int dateStyle, final TimeZone timeZone, final Locale locale)

Gets a date formatter instance using the specified style, time zone and locale.

Parameters

dateStyle:int: date style: FULL, LONG, MEDIUM, or SHORT.
timeZone:TimeZone: optional time zone, overrides time zone of formatted date, null means use default Locale.
locale:Locale: optional locale, overrides system locale.

Returns:F

a localized standard date/time formatter.

Exceptions

IllegalArgumentException:: if the Locale has no date/time pattern defined.

getDateTimeInstance	back to summary
pack-priv F getDateTimeInstance(final int dateStyle, final int timeStyle, final TimeZone timeZone, final Locale locale) Gets a date/time formatter instance using the specified style, time zone and locale. Parameters dateStyle:int date style: FULL, LONG, MEDIUM, or SHORT. timeStyle:int time style: FULL, LONG, MEDIUM, or SHORT. timeZone:TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. locale:Locale optional locale, overrides system locale. Returns:F a localized standard date/time formatter. Exceptions IllegalArgumentException: if the Locale has no date/time pattern defined.

getDateTimeInstance

back to summary

pack-priv F getDateTimeInstance(final int dateStyle, final int timeStyle, final TimeZone timeZone, final Locale locale)

Gets a date/time formatter instance using the specified style, time zone and locale.

Parameters

dateStyle:int: date style: FULL, LONG, MEDIUM, or SHORT.
timeStyle:int: time style: FULL, LONG, MEDIUM, or SHORT.
timeZone:TimeZone: optional time zone, overrides time zone of formatted date, null means use default Locale.
locale:Locale: optional locale, overrides system locale.

Returns:F

a localized standard date/time formatter.

Exceptions

IllegalArgumentException:: if the Locale has no date/time pattern defined.

getDateTimeInstance	back to summary
private F getDateTimeInstance(final Integer dateStyle, final Integer timeStyle, final TimeZone timeZone, Locale locale) Gets a date/time formatter instance using the specified style, time zone and locale. Parameters dateStyle:Integer date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format. timeStyle:Integer time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format. timeZone:TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. locale:Locale optional locale, overrides system locale. Returns:F a localized standard date/time formatter. Exceptions IllegalArgumentException: if the Locale has no date/time pattern defined.

getDateTimeInstance

back to summary

private F getDateTimeInstance(final Integer dateStyle, final Integer timeStyle, final TimeZone timeZone, Locale locale)

Gets a date/time formatter instance using the specified style, time zone and locale.

Parameters

dateStyle:Integer: date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format.
timeStyle:Integer: time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format.
timeZone:TimeZone: optional time zone, overrides time zone of formatted date, null means use default Locale.
locale:Locale: optional locale, overrides system locale.

Returns:F

a localized standard date/time formatter.

Exceptions

IllegalArgumentException:: if the Locale has no date/time pattern defined.

getInstance	back to summary
public F getInstance() Gets a formatter instance using the default pattern in the default time zone and locale. Returns:F a date/time formatter.

getInstance

back to summary

public F getInstance()

Gets a formatter instance using the default pattern in the default time zone and locale.

Returns:F: a date/time formatter.

getInstance back to summary

getInstance	back to summary
public F getInstance(final String pattern, final TimeZone timeZone, final Locale locale) Gets a formatter instance using the specified pattern, time zone and locale. Parameters pattern:String `java.text.SimpleDateFormat` compatible pattern, non-null. timeZone:TimeZone the time zone, null means use the default TimeZone. locale:Locale the locale, null means use the default Locale. Returns:F a pattern based date/time formatter. Exceptions NullPointerException: if pattern is `null`. IllegalArgumentException: if pattern is invalid.

public F getInstance(final String pattern, final TimeZone timeZone, final Locale locale)

Gets a formatter instance using the specified pattern, time zone and locale.

Parameters

pattern:String: java.text.SimpleDateFormat compatible pattern, non-null.
timeZone:TimeZone: the time zone, null means use the default TimeZone.
locale:Locale: the locale, null means use the default Locale.

Returns:F

a pattern based date/time formatter.

Exceptions

NullPointerException:: if pattern is null.
IllegalArgumentException:: if pattern is invalid.

getPatternForStyle	back to summary
pack-priv static String getPatternForStyle(final Integer dateStyle, final Integer timeStyle, final Locale locale) Gets a date/time format for the specified styles and locale. Parameters dateStyle:Integer date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format. timeStyle:Integer time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format. locale:Locale The non-null locale of the desired format. Returns:String a localized standard date/time format. Exceptions IllegalArgumentException: if the Locale has no date/time pattern defined.

getPatternForStyle

back to summary

pack-priv static String getPatternForStyle(final Integer dateStyle, final Integer timeStyle, final Locale locale)

Gets a date/time format for the specified styles and locale.

Parameters

dateStyle:Integer: date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format.
timeStyle:Integer: time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format.
locale:Locale: The non-null locale of the desired format.

Returns:String

a localized standard date/time format.

Exceptions

IllegalArgumentException:: if the Locale has no date/time pattern defined.

getTimeInstance	back to summary
pack-priv F getTimeInstance(final int timeStyle, final TimeZone timeZone, final Locale locale) Gets a time formatter instance using the specified style, time zone and locale. Parameters timeStyle:int time style: FULL, LONG, MEDIUM, or SHORT. timeZone:TimeZone optional time zone, overrides time zone of formatted date, null means use default Locale. locale:Locale optional locale, overrides system locale. Returns:F a localized standard date/time formatter. Exceptions IllegalArgumentException: if the Locale has no date/time pattern defined.

getTimeInstance

back to summary

pack-priv F getTimeInstance(final int timeStyle, final TimeZone timeZone, final Locale locale)

Gets a time formatter instance using the specified style, time zone and locale.

Parameters

timeStyle:int: time style: FULL, LONG, MEDIUM, or SHORT.
timeZone:TimeZone: optional time zone, overrides time zone of formatted date, null means use default Locale.
locale:Locale: optional locale, overrides system locale.

Returns:F

a localized standard date/time formatter.

Exceptions

IllegalArgumentException:: if the Locale has no date/time pattern defined.

org.apache.commons.lang3.time back to summary

private final Class AbstractFormatCache.ArrayKey

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.lang3.time.AbstractFormatCache.ArrayKey

Helper class to hold multipart Map keys as arrays.

Field Summary

Modifier and Type	Field and Description
private final int	hashCode
private final Object[]	keys

Constructor Summary

Access	Constructor and Description
pack-priv	ArrayKey(final Object... the set of objects that make up the key. Each key may be null. keys) Constructs an instance of `MultipartKey` to hold the specified objects.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

hashCode	back to summary
private final int hashCode

keys	back to summary
private final Object[] keys

Constructor Detail

ArrayKey back to summary

ArrayKey	back to summary
pack-priv ArrayKey(final Object... keys) Constructs an instance of `MultipartKey` to hold the specified objects. Parameters keys:Object[] the set of objects that make up the key. Each key may be null.

pack-priv ArrayKey(final Object... keys)

Constructs an instance of MultipartKey to hold the specified objects.

Parameters

keys:Object[]: the set of objects that make up the key. Each key may be null.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

pack-priv abstract Class AbstractFormatCache<F extends Format>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AbstractFormatCache.ArrayKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail