net.java.dev.webdav.jaxrs.xml.elements

Class TimeOut

java.lang.Object

net.java.dev.webdav.jaxrs.xml.elements.TimeOut

public final class TimeOut
extends Object

WebDAV timeout XML Element.

Author:

Markus KARG (mkarg@java.net)

See Also:

Chapter 14.29 "timeout XML Element" of RFC 4918 "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TimeOut.Adapter Guarantees that any unmarshalled enum constants effectively are the constant Java instances itself, so that == can be used form comparison.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeOut	INFINITE

Constructor Summary

Constructors

Constructor and Description
TimeOut(long seconds)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
long	getSeconds()
int	hashCode()
boolean	isInfinite()
String	toString()
static TimeOut	valueOf(String timeType) Factory method creating TimeOut instances from String value representations (e. g. as used in HTTP Headers.TIMEOUT header).

Methods inherited from class java.lang.Object

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

Field Detail

INFINITE

public static final TimeOut INFINITE

Constructor Detail

TimeOut

public TimeOut(long seconds)

Method Detail

isInfinite

public final boolean isInfinite()

getSeconds

public final long getSeconds()

Returns:

The duration of the timeout in seconds, or Long.MAX_VALUE for infinity. Note that future versions will return null for infinity.

equals

public final boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

valueOf

public static final TimeOut valueOf(String timeType)

Factory method creating TimeOut instances from String value representations (e. g. as used in HTTP Headers.TIMEOUT header). Guarantees that INFINITE singleton is returned for "Infinite" string, hence allowing to compare for infinity using == comparison.

Example:
TimeOut to = TimeOut.valueOf("Infinite");
if (to == Timeout.INFINITE) { ... }


Parameters:

timeType - Either Second-n (where n is the length of the timeout) or Infinite.

Returns:

An instance of TimeOut with the length taken from the timeOutHeader string. Instance is guaranteed to be INFINITE in case timeOutHeader is "Infinity".

Since:

1.2.1