com.sapportals.wcm.protocol.ice.util

Class ICEDurationFormat

java.lang.Object

com.sapportals.wcm.protocol.ice.util.ICEDurationFormat

public class ICEDurationFormat
extends Object

Implements the duration format defined in the ICE specification. This format is a specific profile of the choices available in [ISO8601] section 5.5.3.2; note that the alternative format restrictions (5.5.3.2.1) are not used by ICE.

When a period of time needs to be specified, the ICE Duration format is: PnS (or Pn,nS for sub-second granularity) where the "P" (upper case letter P) is a literal character ([ISO8601] designator), "n" is an arbitrarily large integer value, and "S" (upper case letter S) is a literal character. This format denotes a number of seconds (and an optional fractional second part).

Copyright 2004 SAP AG

Constructor Summary

Constructors

Constructor and Description
ICEDurationFormat()

Method Summary

Modifier and Type	Method and Description
static String	format(long milliSeconds) Formats the specified amount of milliseconds as a string adhering to the ICE Duration Format.
static long	parse(String str) Parses the specified string (which must be in ICE Duration Format) and returns the amount of milliseconds it represents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ICEDurationFormat

public ICEDurationFormat()

Method Detail

format

public static String format(long milliSeconds)

Formats the specified amount of milliseconds as a string adhering to the ICE Duration Format.

Note, that the sub-second format will be used only when neccessary. For example, 30000 ms will be returned as "P30S", but 30500 ms as "P30,500S".

Parameters:

milliSeconds - the amount of milliseconds to be formatted

Returns:

a string representation in ICE Duration Format

parse

public static long parse(String str)
                  throws ParseException

Parses the specified string (which must be in ICE Duration Format) and returns the amount of milliseconds it represents.

Parameters:

str - the string to be parsed

Returns:

the amount of milliseconds

Throws:

ParseException - Description of the Exception

ParseException - when specifying an illegally formatted string