org.ops4j.pax.exam

Class RelativeTimeout

java.lang.Object

org.ops4j.pax.exam.RelativeTimeout

All Implemented Interfaces:

Serializable

public class RelativeTimeout
extends Object
implements Serializable

Timout type that is being used in exam to specify a single timeout value but control different timout points in the system with that value. In most cases, clients will just use the value directly as time in milliseconds. However, this type also says that the value is just a (possibly user specified) "hint" and not mean the exaclt value. You can see it as a relative timeout value.

Author:

Toni Menzel (toni@okidokiteam.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static RelativeTimeout	TIMEOUT_DEFAULT
static RelativeTimeout	TIMEOUT_NOTIMEOUT
static RelativeTimeout	TIMEOUT_NOWAIT

Constructor Summary

Constructors

Constructor and Description
RelativeTimeout(long time)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getLowerValue()
long	getUpperValue()
long	getValue()
int	hashCode()
boolean	isDefault()
boolean	isNoTimeout()
boolean	isNoWait()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT_NOWAIT

public static final RelativeTimeout TIMEOUT_NOWAIT

TIMEOUT_NOTIMEOUT

public static final RelativeTimeout TIMEOUT_NOTIMEOUT

TIMEOUT_DEFAULT

public static final RelativeTimeout TIMEOUT_DEFAULT

Constructor Detail

RelativeTimeout

public RelativeTimeout(long time)

Method Detail

getValue

public long getValue()

Returns:

Default Timeout value.

getLowerValue

public long getLowerValue()

Returns:

Tendentiative lower timeout value. This is relative to getValue()

getUpperValue

public long getUpperValue()

Returns:

Tendentiative higher timeout value. This is relative to getValue()

isNoWait

public boolean isNoWait()

isNoTimeout

public boolean isNoTimeout()

isDefault

public boolean isDefault()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object