Class TimeInterval
- java.lang.Object
-
- org.apache.tapestry5.commons.util.TimeInterval
-
public class TimeInterval extends java.lang.Object
Used to represent a period of time, specifically as a configuration value. This is often used to specify timeouts. TimePeriods are parsed from strings. The string specifys a number of terms. The values of all the terms are summed together to form the total time period. Each term consists of a number followed by a unit. Units (from largest to smallest) are:- y
- year
- d
- day
- h
- hour
- m
- minute
- s
- second
- ms
- millisecond
-
-
Constructor Summary
Constructors Constructor Description TimeInterval(long milliseconds)TimeInterval(java.lang.String input)Creates a TimeInterval for a string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)longmilliseconds()longseconds()java.lang.StringtoDescription()Converts the milliseconds back into a string (compatible withTimeInterval(String)).java.lang.StringtoString()
-
-
-
Constructor Detail
-
TimeInterval
public TimeInterval(java.lang.String input)
Creates a TimeInterval for a string.- Parameters:
input- the string specifying the amount of time in the period
-
TimeInterval
public TimeInterval(long milliseconds)
-
-
Method Detail
-
milliseconds
public long milliseconds()
-
seconds
public long seconds()
-
toDescription
public java.lang.String toDescription()
Converts the milliseconds back into a string (compatible withTimeInterval(String)).- Since:
- 5.2.0
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
-