public Class StdDateFormat

Defines a commonly used date format that conforms to ISO-8601 date formatting standard, when it includes basic undecorated timezone definition.

A singleton instance can be used for cloning purposes, as a blueprint of sorts.

Overrides java.text.DateFormat.clone.

Doc from java.text.DateFormat.clone.

Overrides Cloneable

Returns:StdDateFormat

Doc from java.text.Format.clone.

a clone of this instance.

Annotations

@Override

Overrides java.text.DateFormat.equals.

Doc from java.text.DateFormat.equals.

Compares the specified object with this DateFormat for equality. Returns true if the object is also a DateFormat and the two formats would format any value the same.

Parameters

o:Object

object to be compared for equality

Returns:boolean

true if the specified object is equal to this DateFormat

Annotations

@Override

Implements abstract java.text.DateFormat.format.

Doc from java.text.DateFormat.format.

Formats a Date into a date-time string. The formatted string is appended to the given StringBuffer.

Parameters

date:Date

a Date to be formatted into a date-time string.

toAppendTo:StringBuffer

the string buffer for the returning date-time string.

fieldPosition:FieldPosition

keeps track on the position of the field within the returned string. For example, given a date-time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition is DateFormat#YEAR_FIELD, the begin index and end index of fieldPosition will be set to 0 and 4, respectively. Notice that if the same date-time field appears more than once in a pattern, the fieldPosition will be set for the first occurrence of that date-time field. For instance, formatting a Date to the date-time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat#TIMEZONE_FIELD, the begin index and end index of fieldPosition will be set to 5 and 8, respectively, for the first occurrence of the timezone pattern character 'z'.

Returns:StringBuffer

the string buffer passed in as toAppendTo, with formatted text appended.

Annotations

@Override

Method for getting a non-shared DateFormat instance that uses specified timezone and can handle simple ISO-8601 compliant date format.

Annotations

@Deprecated

Since

2.4

Method for getting a non-shared DateFormat instance that uses specific timezone and can handle RFC-1123 compliant date format.

Annotations

@Deprecated

Since

2.4

Overrides java.text.DateFormat.getTimeZone.

Doc from java.text.DateFormat.getTimeZone.

Gets the time zone. This method is equivalent to the following call.

 getCalendar().getTimeZone();

getCalendar().getTimeZone();

Returns:TimeZone

the time zone associated with the calendar of DateFormat.

Annotations

@Override

Overrides java.text.DateFormat.hashCode.

Doc from java.text.DateFormat.hashCode.

Returns the hash code for this DateFormat.

Returns:int

the hash code for this DateFormat

Annotations

@Override

Accessor for checking whether this instance would include colon within timezone serialization or not: if {code true}, timezone offset is serialized like -06:00; if {code false} as -0600.

Returns:boolean

true if a colon is to be inserted between the hours and minutes of the TZ offset when serializing as String; otherwise false

Since

2.9.1

Overrides java.text.DateFormat.isLenient.

Doc from java.text.DateFormat.isLenient.

Tell whether date/time parsing is to be lenient. This method is equivalent to the following call.

 getCalendar().isLenient();

getCalendar().isLenient();

Returns:boolean

true if the calendar is lenient; false otherwise.

Annotations

@Override

Overrides java.text.DateFormat.parse.

Doc from java.text.DateFormat.parse.

Parses text from the beginning of the given string to produce a date. The method may not use the entire text of the given string.

See the parse(String, ParsePosition) method for more information on date parsing.

Parameters

dateStr:String

A String whose beginning should be parsed.

Returns:Date

A Date parsed from the string.

Annotations

@Override

Exceptions

ParseException:

if the beginning of the specified string cannot be parsed.

Implements abstract java.text.DateFormat.parse.

Doc from java.text.DateFormat.parse.

Parse a date/time string according to the given parse position. For example, if this has the pattern "M/d/yy h:m a, z", then a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039900000L).

By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).

This parsing operation uses the calendar to produce a Date. As a result, the calendar's date-time fields and the TimeZone value may have been overwritten, depending on subclass implementations. Any TimeZone value that has previously been set by a call to setTimeZone may need to be restored for further operations.

Parameters

dateStr:String

The date/time string to be parsed

pos:ParsePosition

On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.

Returns:Date

A Date, or null if the input could not be parsed

Annotations

@Override

Overrides java.text.DateFormat.setLenient.

Need to override since we need to keep track of leniency locally, and not via underlying Calendar instance like base class does.

Parameters

enabled:boolean

Doc from java.text.DateFormat.setLenient.

when true, parsing is lenient

Annotations

@Override

Overrides java.text.DateFormat.setTimeZone.

Doc from java.text.DateFormat.setTimeZone.

Sets the time zone for the calendar of this DateFormat object. This method is equivalent to the following call.

 getCalendar().setTimeZone(zone);

getCalendar().setTimeZone(zone);

The TimeZone set by this method is overwritten by a setCalendar call.

The TimeZone set by this method may be overwritten as a result of a call to the parse method.

Parameters

tz:TimeZone

the given new time zone.

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

"Mutant factory" method that will return an instance that has specified handling of colon when serializing timezone (timezone either written like +0500 or +05:00): either this instance (if setting would not change), or newly constructed instance with desired setting for colon inclusion.

Since

2.9.1

"Mutant factory" method that will return an instance that has specified leniency setting: either this instance (if setting would not change), or newly constructed instance.

Since

2.9

"Mutant factory" method that will return an instance that uses specified Locale: either this instance (if setting would not change), or newly constructed instance with different Locale to use.

Method used for creating a new instance with specified timezone; if no timezone specified, defaults to the default timezone (UTC).