com.devexperts.util

Class TimePeriod

java.lang.Object

com.devexperts.util.TimePeriod

All Implemented Interfaces:

Serializable

public class TimePeriod
extends Object
implements Serializable

Value class for period of time with support for ISO8601 duration format.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TimePeriod	UNLIMITED Time-period of "infinity" (time of Long.MAX_VALUE).
static TimePeriod	ZERO Time-period of zero.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimePeriod(long value)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getNanos() Returns value in nanoseconds.
int	getSeconds()
long	getTime() Returns value in milliseconds.
int	hashCode()
protected static long	parse(String value)
String	toString()
static TimePeriod	valueOf(long value) Returns TimePeriod with value milliseconds.
static TimePeriod	valueOf(String value) Returns TimePeriod represented with a given string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final TimePeriod ZERO

Time-period of zero.

UNLIMITED

public static final TimePeriod UNLIMITED

Time-period of "infinity" (time of Long.MAX_VALUE).

Constructor Detail

TimePeriod

protected TimePeriod(long value)

Method Detail

valueOf

public static TimePeriod valueOf(long value)

Returns TimePeriod with value milliseconds.

Parameters:

value - value in milliseconds

Returns:

TimePeriod with value milliseconds.

valueOf

public static TimePeriod valueOf(String value)
                          throws InvalidFormatException

Returns TimePeriod represented with a given string. Allowable format is ISO8601 duration, but there are some simplifications and modifications available:

• Letters are case insensitive.
• Letters "P" and "T" can be omitted.
• Letter "S" can be also omitted. In this case last number will be supposed to be seconds.
• Number of seconds can be fractional. So it is possible to define duration accurate within milliseconds.
• Every part can be omitted. It is supposed that it's value is zero then.
• String "inf" recognized as unlimited period.

Parameters:

value - string representation

Returns:

TimePeriod represented with a given string.

Throws:

InvalidFormatException - if cannot parse value

parse

protected static long parse(String value)

toString

public String toString()

Overrides:

toString in class Object

getTime

public long getTime()

Returns value in milliseconds.

Returns:

value in milliseconds

getSeconds

public int getSeconds()

getNanos

public long getNanos()

Returns value in nanoseconds.

Returns:

value in nanoseconds

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object