ISO8601

java.lang.Object
- jade.lang.acl.ISO8601

```
public class ISO8601
extends Object
```
This class contains a set of static methods that convert to/from the Date Time format adopted by FIPA. The FIPA format is based on ISO8601, with the addition of milliseconds. Using the java.text.SimpleDateFormat notation, it is: yyyyMMdd'T'HHmmssSSS'Z' , where the 'T' serves to separate the Day from the Time, and the 'Z' indicates that the time is in UTC. The FIPA specs permit either local or UTC time, however, they do express a preference for UTC time (this is particularly helpful when passing messages between agents running on machines in different timezones).
- Older versions of this code:
  - read DateTime as local time
  - wrote DateTime as local time
- Current versions of this code:
  - read DateTime in both local time and UTC time
  - write DateTime as UTC time by default (can generate local time if toString(false) is called).
Version:

0.9 Modified by:

Author:

Fabio Bellifemine - CSELT, Craig Sayers, HP Labs, Palo Alto, California

Field Summary

Fields
Modifier and Type	Field and Description
`private static long`	`day`
`private static long`	`hour`
`private static Calendar`	`localCal`
`private static char`	`minus`
`private static long`	`minute`
`private static long`	`month`
`private static char`	`plus`
`private static long`	`sec`
`private static char`	`t`
`private static Calendar`	`utcCal`
`private static long`	`year`
`private static String`	`z`

Constructor Summary

Constructors
Constructor and Description

ISO8601()
Default constructor.

Constructors
Constructor and Description
`ISO8601()` Default constructor.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`private static String`	`formatlocalDate(Date d)`
`private static String`	`formatutcDate(Date d)`
`static void`	`main(String[] argv)` The main is here only for debugging.
`private static Date`	`parselocalDateFormat(String dateTimeToken)` parse a date time token in local format (i.e.
`private static Date`	`parseutcDateFormat(String dateTimeToken)` parse a date time token in UTC format (i.e.
`private static String`	`subFormatDate(Calendar cal)`
`private static void`	`subparse(Calendar cal, String dateTimeToken)`
`static Date`	`toDate(String dateTimeToken)` This method converts a FIPA DateTime token to a `java.util.Date`.
`static String`	`toRelativeTimeString(long millisec)` this method converts into a string in ISO8601 format representing relative time from the current time
`static String`	`toString(Date d)` This method converts a `java.util.Date` into a FIPA DateTime token by using the UTC time.
`static String`	`toString(Date d, boolean useUTCtime)` This method converts a `java.util.Date` into a FIPA DateTime token.
`private static String`	`zeroPaddingNumber(long value, int digits)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - localCal
```
private static Calendar localCal
```
  - utcCal
```
private static Calendar utcCal
```
  - plus
```
private static char plus
```
  - minus
```
private static char minus
```
  - z
```
private static String z
```
  - t
```
private static char t
```
  - year
```
private static final long year
```
    See Also:
    
    Constant Field Values
  - month
```
private static final long month
```
    See Also:
    
    Constant Field Values
  - day
```
private static final long day
```
    See Also:
    
    Constant Field Values
  - hour
```
private static final long hour
```
    See Also:
    
    Constant Field Values
  - minute
```
private static final long minute
```
    See Also:
    
    Constant Field Values
  - sec
```
private static final long sec
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ISO8601
```
public ISO8601()
```
    Default constructor.
- Method Detail
  - parseutcDateFormat
```
private static Date parseutcDateFormat(String dateTimeToken)
                                throws Exception
```
    parse a date time token in UTC format (i.e. ending with a Z)
    
    Throws:
    
    Exception
  - parselocalDateFormat
```
private static Date parselocalDateFormat(String dateTimeToken)
                                  throws Exception
```
    parse a date time token in local format (i.e. ending with a Z)
    
    Throws:
    
    Exception
  - subparse
```
private static void subparse(Calendar cal,
                             String dateTimeToken)
```
  - formatlocalDate
```
private static String formatlocalDate(Date d)
```
  - formatutcDate
```
private static String formatutcDate(Date d)
```
  - subFormatDate
```
private static String subFormatDate(Calendar cal)
```
  - toDate
```
public static Date toDate(String dateTimeToken)
                   throws Exception
```
    This method converts a FIPA DateTime token to a java.util.Date. It will accept both local and UTC time formats.
    
    Returns:
    
    an absolute value of DateTime
    
    Throws:
    
    an - Exception if the String is not a valid dateTime
    
    Exception
  - toString
```
public static String toString(Date d,
                              boolean useUTCtime)
```
    This method converts a java.util.Date into a FIPA DateTime token. Note: the current default behaviour is to generate dates in UTC time. see ISO8601.useUTCtime for details.
    
    Parameters:
    
    useUTCtime - controls the style used by toString, 'true' generates tokens using UTC time, 'false' using local time. If you need to send messages to agents compiled with older versions of Jade, then set this to false.
    
    Returns:
    
    a String, e.g. "19640625T073000000Z" to represent 7:30AM on the 25th of June of 1964, UTC time.
  - toString
```
public static String toString(Date d)
```
    This method converts a java.util.Date into a FIPA DateTime token by using the UTC time.
    
    Returns:
    
    a String, e.g. "19640625T073000000Z" to represent 7:30AM on the 25th of June of 1964, UTC time.
  - toRelativeTimeString
```
public static String toRelativeTimeString(long millisec)
```
    this method converts into a string in ISO8601 format representing relative time from the current time
    
    Parameters:
    
    millisec - is the number of milliseconds from now
    
    Returns:
    
    a String, e.g. "+00000000T010000000" to represent one hour from now
  - zeroPaddingNumber
```
private static String zeroPaddingNumber(long value,
                                        int digits)
```
  - main
```
public static void main(String[] argv)
```
    The main is here only for debugging. You can test your conversion by executing the following command:
    java jade.lang.acl.ISO8601

Class ISO8601

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

localCal

utcCal

plus

minus

z

t

year

month

day

hour

minute

sec

Constructor Detail

ISO8601

Method Detail

parseutcDateFormat

parselocalDateFormat

subparse

formatlocalDate

formatutcDate

subFormatDate

toDate

toString

toString

toRelativeTimeString

zeroPaddingNumber

main