Class NamedTimeoutConstraint

java.lang.Object

org.apache.ivy.core.settings.NamedTimeoutConstraint

All Implemented Interfaces:

TimeoutConstraint

public class NamedTimeoutConstraint
extends Object
implements TimeoutConstraint

An implementation of TimeoutConstraint which can be identified by a name

Constructor Summary

Constructors

Constructor	Description
NamedTimeoutConstraint()
NamedTimeoutConstraint(String name)

Method Summary

Modifier and Type	Method	Description
int	getConnectionTimeout()
String	getName()
int	getReadTimeout()
void	setConnectionTimeout(int connectionTimeout)	Sets the connection timeout of this timeout constraint
void	setName(String name)
void	setReadTimeout(int readTimeout)	Sets the read timeout of this timeout constraint

Methods inherited from class Object

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

Constructor Details

NamedTimeoutConstraint

public NamedTimeoutConstraint()

NamedTimeoutConstraint

public NamedTimeoutConstraint(String name)

Method Details

setName

public void setName(String name)

getName

public String getName()

Returns:

Returns the name of the timeout constraint

getConnectionTimeout

public int getConnectionTimeout()

Specified by:

getConnectionTimeout in interface TimeoutConstraint

Returns:

Returns the timeout, in milliseconds, that's to be used while establishing a connection to a resource. A value greater than zero indicates the specific timeout to be used. A value of 0 indicates no timeout and essentially translates to wait-forever semantics. A value lesser than 0 lets the users of this TimeoutConstraint decide what kind of timeout semantics to use while establishing a connection (for example, some implementations can decide to use some default value).

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface TimeoutConstraint

Returns:

Returns the timeout, in milliseconds, that's to be used while reading content from a resource. A value greater than zero indicates the specific timeout to be used. A value of 0 indicates no timeout and essentially translates to wait-forever semantics. A value lesser than 0 lets the users of this TimeoutConstraint decide what kind of timeout semantics to use reading from the resource (for example, some implementations can decide to use some default value).

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Sets the connection timeout of this timeout constraint

Parameters:

connectionTimeout - The connection timeout in milliseconds.

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets the read timeout of this timeout constraint

Parameters:

readTimeout - The read timeout in milliseconds.