ISO8601Date (Java Utilities 2.4 API)

java.lang.Object
- java.util.Date
- - net.pwall.util.ISO8601Date

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Date>
```
public class ISO8601Date
extends Date
```
ISO 8601 Date.

Author:

Peter Wall

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAY_OF_MONTH_MASK`
`static int`	`DAY_OF_WEEK_MASK`
`static int`	`DAY_OF_YEAR_MASK`
`static int`	`HOUR_OF_DAY_MASK`
`static int`	`MILLISECOND_MASK`
`static int`	`MINUTE_MASK`
`static int`	`MONTH_MASK`
`static int`	`SECOND_MASK`
`static int`	`WEEK_OF_YEAR_MASK`
`static int`	`YEAR_MASK`
`static int`	`ZONE_OFFSET_MASK`

Constructor Summary

Constructors
Constructor and Description
`ISO8601Date()`
`ISO8601Date(Calendar cal)`
`ISO8601Date(Date date, TimeZone timeZone)`
`ISO8601Date(ISO8601Date date)`
`ISO8601Date(long date)`
`ISO8601Date(String date)`
`ISO8601Date(String date, TimeZone timeZone)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Calendar`	`decode(CharSequence str)` Parse an ISO 8601 date into a `Calendar` object.
`static Calendar`	`getCalendar()` Get a `Calendar` object in a suitable form for ISO 8601 dates.
`TimeZone`	`getTimeZone()`
`void`	`setTime(long time)`
`void`	`setTimeZone(TimeZone timeZone)`
`String`	`toString()`
`static String`	`toString(Calendar cal)` Convert a `Calendar` object to an ISO 8601 string.
`static String`	`toString(Calendar cal, boolean extended)` Convert a `Calendar` object to an ISO 8601 string.
`static String`	`toString(Calendar cal, boolean extended, int fields)` Convert a `Calendar` object to an ISO 8601 string.
`static String`	`toString(Date date)`
`static String`	`toString(Date date, TimeZone timeZone)`

Methods inherited from class java.util.Date
after, before, clone, compareTo, equals, from, getDate, getDay, getHours, getMinutes, getMonth, getSeconds, getTime, getTimezoneOffset, getYear, hashCode, parse, setDate, setHours, setMinutes, setMonth, setSeconds, setYear, toGMTString, toInstant, toLocaleString, UTC

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - YEAR_MASK
```
public static final int YEAR_MASK
```
    See Also:
    
    Constant Field Values
  - MONTH_MASK
```
public static final int MONTH_MASK
```
    See Also:
    
    Constant Field Values
  - WEEK_OF_YEAR_MASK
```
public static final int WEEK_OF_YEAR_MASK
```
    See Also:
    
    Constant Field Values
  - DAY_OF_MONTH_MASK
```
public static final int DAY_OF_MONTH_MASK
```
    See Also:
    
    Constant Field Values
  - DAY_OF_YEAR_MASK
```
public static final int DAY_OF_YEAR_MASK
```
    See Also:
    
    Constant Field Values
  - DAY_OF_WEEK_MASK
```
public static final int DAY_OF_WEEK_MASK
```
    See Also:
    
    Constant Field Values
  - HOUR_OF_DAY_MASK
```
public static final int HOUR_OF_DAY_MASK
```
    See Also:
    
    Constant Field Values
  - MINUTE_MASK
```
public static final int MINUTE_MASK
```
    See Also:
    
    Constant Field Values
  - SECOND_MASK
```
public static final int SECOND_MASK
```
    See Also:
    
    Constant Field Values
  - MILLISECOND_MASK
```
public static final int MILLISECOND_MASK
```
    See Also:
    
    Constant Field Values
  - ZONE_OFFSET_MASK
```
public static final int ZONE_OFFSET_MASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ISO8601Date
```
public ISO8601Date()
```
  - ISO8601Date
```
public ISO8601Date(long date)
```
  - ISO8601Date
```
public ISO8601Date(String date)
```
  - ISO8601Date
```
public ISO8601Date(String date,
                   TimeZone timeZone)
```
  - ISO8601Date
```
public ISO8601Date(Date date,
                   TimeZone timeZone)
```
  - ISO8601Date
```
public ISO8601Date(Calendar cal)
```
  - ISO8601Date
```
public ISO8601Date(ISO8601Date date)
```
- Method Detail
  - getTimeZone
```
public TimeZone getTimeZone()
```
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
  - setTime
```
public void setTime(long time)
```
    Overrides:
    
    setTime in class Date
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Date
  - toString
```
public static String toString(Date date,
                              TimeZone timeZone)
```
  - toString
```
public static String toString(Date date)
```
  - getCalendar
```
public static Calendar getCalendar()
```
    Get a Calendar object in a suitable form for ISO 8601 dates.
    
    Returns:
    
    Calendar object
  - decode
```
public static Calendar decode(CharSequence str)
```
    Parse an ISO 8601 date into a Calendar object.
    
    Parameters:
    
    str - the input date in CharSequence (e.g. String) format
    
    Returns:
    
    a Calendar object containing the date details from the input
    
    Throws:
    
    IllegalArgumentException - if the input date is invalid
  - toString
```
public static String toString(Calendar cal)
```
    Convert a Calendar object to an ISO 8601 string. This function outputs to the string only those fields that are marked as having been set explicitly.
    The "extended" format will be used, that is, date and time separators will be included.
    
    Parameters:
    
    cal - a Calendar object
    
    Returns:
    
    the date represented by the Calendar in ISO 8601 format
  - toString
```
public static String toString(Calendar cal,
                              boolean extended)
```
    Convert a Calendar object to an ISO 8601 string. This function outputs to the string only those fields that are marked as having been set explicitly.
    
    Parameters:
    
    cal - a Calendar object
    
    extended - if true, use "extended" format (include date and time separators)
    
    Returns:
    
    the date represented by the Calendar in ISO 8601 format
  - toString
```
public static String toString(Calendar cal,
                              boolean extended,
                              int fields)
```
    Convert a Calendar object to an ISO 8601 string. This function outputs to the string only those fields selected in a bit mask of field designators. Not all field combinations are valid. The bit mask values are:
    
    YEAR_MASK
    
    Output the year
    
    MONTH_MASK
    
    Output the month
    
    DAY_OF_MONTH_MASK
    
    Output the day of month
    
    WEEK_OF_YEAR_MASK
    
    Output the week of year
    
    DAY_OF_WEEK_MASK
    
    Output the day of week
    
    DAY_OF_YEAR_MASK
    
    Output the day of year
    
    HOUR_OF_DAY_MASK
    
    Output the hour of day
    
    MINUTE_MASK
    
    Output the minutes
    
    SECOND_MASK
    
    Output the seconds
    
    MILLISECOND_MASK
    
    Output the milliseconds
    
    ZONE_OFFSET_MASK
    
    Output the time zone offset
    
    Parameters:
    
    cal - a Calendar object
    
    extended - if true, use "extended" format (include date and time separators)
    
    fields - the selected fields
    
    Returns:
    
    the date represented by the Calendar in ISO 8601 format

Class ISO8601Date

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Date

Methods inherited from class java.lang.Object

Field Detail

YEAR_MASK

MONTH_MASK

WEEK_OF_YEAR_MASK

DAY_OF_MONTH_MASK

DAY_OF_YEAR_MASK

DAY_OF_WEEK_MASK

HOUR_OF_DAY_MASK

MINUTE_MASK

SECOND_MASK

MILLISECOND_MASK

ZONE_OFFSET_MASK

Constructor Detail

ISO8601Date

ISO8601Date

ISO8601Date

ISO8601Date

ISO8601Date

ISO8601Date

ISO8601Date

Method Detail

getTimeZone

setTimeZone

setTime

toString

toString

toString

getCalendar

decode

toString

toString

toString