com.flipkart.polyguice.config

Class TimeInterval

java.lang.Object

com.flipkart.polyguice.config.TimeInterval

public class TimeInterval
extends Object

This class encapsulates a time interval value as a delta between two events. Internally, the value is always stored in milliseconds.

At the time of creation, the time interval is always specified as a string input. The input contains a numeric part suffixed with a 's', 'm', 'h' or 'd' to signify that the numeric value is in seconds, minutes, hours or days. Note that there should not be any whitespace between the numeric part and the suffix.

Author:

indroneel.das

Constructor Summary

Constructors

Constructor and Description
TimeInterval() Creates a time interval with internal value of -1 (invalid/unset value).
TimeInterval(String timeValue) Creates a time interval populated with information from the specified string value.

Method Summary

Modifier and Type	Method and Description
long	getValue() Retrieves the internally stored time interval value.
void	setValue(String timeValue) Populates the time interval with information from the specified string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeInterval

public TimeInterval()

Creates a time interval with internal value of -1 (invalid/unset value).

TimeInterval

public TimeInterval(String timeValue)

Creates a time interval populated with information from the specified string value.

Parameters:

timeValue - the information for initializing a time inerval value.

Method Detail

setValue

public void setValue(String timeValue)

Populates the time interval with information from the specified string value.

Parameters:

timeValue - the information for initializing a time inerval value.

getValue

public long getValue()

Retrieves the internally stored time interval value.

Returns:

the time interval in milliseconds.