Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
Format
org.apache.commons.lang.time.FastDateFormat
public class FastDateFormat
extends Format
SimpleDateFormat
.
This class can be used as a direct replacement to
SimpleDateFormat
in most formatting situations.
This class is especially useful in multi-threaded server environments.
SimpleDateFormat
is not thread-safe in any JDK version,
nor will it be as Sun have closed the bug/RFE.
Only formatting is supported, but all patterns are compatible with
SimpleDateFormat (except time zones - see below).
Java 1.4 introduced a new pattern letter, 'Z'
, to represent
time zones in RFC822 format (eg. +0800
or -1100
).
This pattern letter can be used here (on all JDK versions).
In addition, the pattern 'ZZ'
has been made to represent
ISO8601 full format time zones (eg. +08:00
or -11:00
).
This introduces a minor incompatibility with Java 1.4, but at a gain of
useful functionality.
Field Summary | |
static int |
|
static int |
|
static int |
|
static int |
|
Constructor Summary | |
|
Method Summary | |
protected StringBuffer |
|
boolean |
|
String |
|
StringBuffer |
|
String |
|
StringBuffer |
|
StringBuffer |
|
String |
|
StringBuffer |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
Locale |
|
int |
|
String |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
static FastDateFormat |
|
TimeZone |
|
boolean |
|
int |
|
protected void |
|
Object |
|
protected List |
|
protected String |
|
protected org.apache.commons.lang.time.FastDateFormat.NumberRule |
|
String |
|
public static final int FULL
FULL locale dependent date or time style.
public static final int LONG
LONG locale dependent date or time style.
public static final int MEDIUM
MEDIUM locale dependent date or time style.
public static final int SHORT
SHORT locale dependent date or time style.
protected FastDateFormat(String pattern, TimeZone timeZone, Locale locale)
Constructs a new FastDateFormat.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- time zone to use,null
means use default forDate
and value within forCalendar
locale
- locale,null
means use system default
protected StringBuffer applyRules(Calendar calendar, StringBuffer buf)
Performs the formatting by applying the rules to the specified calendar.
- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into
- Returns:
- the specified string buffer
public boolean equals(Object obj)
Compare two objects for equality.
- Parameters:
obj
- the object to compare to
- Returns:
true
if equal
public String format(Calendar calendar)
Formats aCalendar
object.
- Parameters:
calendar
- the calendar to format
- Returns:
- the formatted string
public StringBuffer format(Calendar calendar, StringBuffer buf)
Formats aCalendar
object into the suppliedStringBuffer
.
- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into
- Returns:
- the specified string buffer
public String format(Date date)
Formats aDate
object.
- Parameters:
date
- the date to format
- Returns:
- the formatted string
public StringBuffer format(Date date, StringBuffer buf)
Formats aDate
object into the suppliedStringBuffer
.
- Parameters:
date
- the date to formatbuf
- the buffer to format into
- Returns:
- the specified string buffer
public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
Formats aDate
,Calendar
orLong
(milliseconds) object.
- Parameters:
obj
- the object to formattoAppendTo
- the buffer to append topos
- the position - ignored
- Returns:
- the buffer passed in
public String format(long millis)
Formats a millisecondlong
value.
- Parameters:
millis
- the millisecond value to format
- Returns:
- the formatted string
- Since:
- 2.1
public StringBuffer format(long millis, StringBuffer buf)
Formats a milliseondlong
value into the suppliedStringBuffer
.
- Parameters:
millis
- the millisecond value to formatbuf
- the buffer to format into
- Returns:
- the specified string buffer
- Since:
- 2.1
public static FastDateFormat getDateInstance(int style)
Gets a date formatter instance using the specified style in the default time zone and locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORT
- Returns:
- a localized standard date formatter
- Since:
- 2.1
public static FastDateFormat getDateInstance(int style, Locale locale)
Gets a date formatter instance using the specified style and locale in the default time zone.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale
- Returns:
- a localized standard date formatter
- Since:
- 2.1
public static FastDateFormat getDateInstance(int style, TimeZone timeZone)
Gets a date formatter instance using the specified style and time zone in the default locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted date
- Returns:
- a localized standard date formatter
- Since:
- 2.1
public static FastDateFormat getDateInstance(int style, TimeZone timeZone, Locale locale)
Gets a date formatter instance using the specified style, time zone and locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale
- Returns:
- a localized standard date formatter
public static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle)
Gets a date/time formatter instance using the specified style in the default time zone and locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORT
- Returns:
- a localized standard date/time formatter
- Since:
- 2.1
public static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, Locale locale)
Gets a date/time formatter instance using the specified style and locale in the default time zone.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale
- Returns:
- a localized standard date/time formatter
- Since:
- 2.1
public static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone)
Gets a date/time formatter instance using the specified style and time zone in the default locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted date
- Returns:
- a localized standard date/time formatter
- Since:
- 2.1
public static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone, Locale locale)
Gets a date/time formatter instance using the specified style, time zone and locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale
- Returns:
- a localized standard date/time formatter
public static FastDateFormat getInstance()
Gets a formatter instance using the default pattern in the default locale.
- Returns:
- a date/time formatter
public static FastDateFormat getInstance(String pattern)
Gets a formatter instance using the specified pattern in the default locale.
- Parameters:
pattern
-SimpleDateFormat
compatible pattern
- Returns:
- a pattern based date/time formatter
public static FastDateFormat getInstance(String pattern, Locale locale)
Gets a formatter instance using the specified pattern and locale.
- Parameters:
pattern
-SimpleDateFormat
compatible patternlocale
- optional locale, overrides system locale
- Returns:
- a pattern based date/time formatter
public static FastDateFormat getInstance(String pattern, TimeZone timeZone)
Gets a formatter instance using the specified pattern and time zone.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted date
- Returns:
- a pattern based date/time formatter
public static FastDateFormat getInstance(String pattern, TimeZone timeZone, Locale locale)
Gets a formatter instance using the specified pattern, time zone and locale.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale
- Returns:
- a pattern based date/time formatter
public Locale getLocale()
Gets the locale used by this formatter.
- Returns:
- the locale
public int getMaxLengthEstimate()
Gets an estimate for the maximum string length that the formatter will produce. The actual formatted length will almost always be less than or equal to this amount.
- Returns:
- the maximum formatted length
public String getPattern()
Gets the pattern used by this formatter.
- Returns:
- the pattern,
SimpleDateFormat
compatible
public static FastDateFormat getTimeInstance(int style)
Gets a time formatter instance using the specified style in the default time zone and locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORT
- Returns:
- a localized standard time formatter
- Since:
- 2.1
public static FastDateFormat getTimeInstance(int style, Locale locale)
Gets a time formatter instance using the specified style and locale in the default time zone.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale
- Returns:
- a localized standard time formatter
- Since:
- 2.1
public static FastDateFormat getTimeInstance(int style, TimeZone timeZone)
Gets a time formatter instance using the specified style and time zone in the default locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted time
- Returns:
- a localized standard time formatter
- Since:
- 2.1
public static FastDateFormat getTimeInstance(int style, TimeZone timeZone, Locale locale)
Gets a time formatter instance using the specified style, time zone and locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted timelocale
- optional locale, overrides system locale
- Returns:
- a localized standard time formatter
public TimeZone getTimeZone()
Gets the time zone used by this formatter. This zone is always used forDate
formatting. If aCalendar
is passed in to be formatted, the time zone on that may be used depending ongetTimeZoneOverridesCalendar()
.
- Returns:
- the time zone
public boolean getTimeZoneOverridesCalendar()
Returnstrue
if the time zone of the calendar overrides the time zone of the formatter.
- Returns:
true
if time zone of formatter overridden for calendars
public int hashCode()
A suitable hashcode.
- Returns:
- a hashcode compatible with equals
protected void init()
Initialise the instance for first use.
public Object parseObject(String source, ParsePosition pos)
Parsing not supported.
- Parameters:
source
- the string to parsepos
- the parsing position
- Returns:
null
as not supported
protected List parsePattern()
Returns a list of Rules given a pattern.
- Returns:
- a
List
of Rule objects
protected String parseToken(String pattern, int[] indexRef)
Performs the parsing of tokens.
- Parameters:
pattern
- the patternindexRef
- index references
- Returns:
- parsed token
protected org.apache.commons.lang.time.FastDateFormat.NumberRule selectNumberRule(int field, int padding)
Gets an appropriate rule for the padding required.
- Parameters:
field
- the field to get a rule forpadding
- the padding required
- Returns:
- a new rule with the correct padding
public String toString()
Gets a debugging string version of this formatter.
- Returns:
- a debugging string