|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.remote.prc.TimeInterval
A type used to represents the numeric value and the unit component of a time interval.
See
IDocumentManager.setBrokenLinkDeletionTime(int, com.plumtree.remote.prc.TimeInterval)
and
IDocumentManager.setRefreshRate(int, com.plumtree.remote.prc.TimeInterval, boolean)
.
Field Summary | |
static TimeInterval |
INFINITE
A static field to represent an infinite time interval. |
Constructor Summary | |
TimeInterval(int value,
TimeIntervalUnit unit)
Creates a TimeInterval with the specified value and unit. |
Method Summary | |
TimeIntervalUnit |
getUnit()
Returns the unit of the time interval. |
int |
getValue()
Returns the value of the time interval. |
void |
setUnit(TimeIntervalUnit unit)
Sets the unit of the time interval. |
void |
setValue(int value)
Sets the value of the interval. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final TimeInterval INFINITE
Integer.MAX_VALUE
and default unit
is TimeIntervalUnit.UNSET
.
IllegalStateException
will be thrown.
Constructor Detail |
public TimeInterval(int value, TimeIntervalUnit unit)
TimeInterval
with the specified value and unit.
value
- the numeric component of a time intervalunit
- the unit component of the time interval; cannot be TimeIntervalUnit.UNSET
java.lang.IllegalArgumentException
- if TimeIntervalUnit.UNSET
is set to be the unitMethod Detail |
public TimeIntervalUnit getUnit()
TimeInterval.INFINITE
,
TimeIntervalUnit.UNSET
will be returned.
public void setUnit(TimeIntervalUnit unit)
unit
- the unit of the time interval
java.lang.IllegalStateException
- if the current instance is a TimeInterval.INFINITE
public int getValue()
TimeInterval.INFINITE
,
Integer.MAX_VALUE
will be returned.
public void setValue(int value)
value
- the numeric value of the time interval
java.lang.IllegalStateException
- if the current instance is a TimeInterval.INFINITE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.