com.dsi.ant.message

Enum LowPrioritySearchTimeout

java.lang.Object

java.lang.Enum<LowPrioritySearchTimeout>

com.dsi.ant.message.LowPrioritySearchTimeout

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LowPrioritySearchTimeout>

public enum LowPrioritySearchTimeout
extends java.lang.Enum<LowPrioritySearchTimeout>

The duration the slave channel will search for a master channel, in low priority mode. This will impact other channels open on the same Adapter.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED
FIFTEEN_SECONDS
FIVE_SECONDS
SEVEN_AND_A_HALF_SECONDS
SEVENTEEN_AND_A_HALF_SECONDS
TEN_SECONDS
TWELVE_AND_A_HALF_SECONDS
TWENTY_FIVE_SECONDS
TWENTY_SECONDS
TWENTY_TWO_AND_A_HALF_SECONDS
TWO_AND_A_HALF_SECONDS

Field Summary

Fields

Modifier and Type	Field and Description
static LowPrioritySearchTimeout	DEFAULT The timeout value set after a channel is assigned
static LowPrioritySearchTimeout	MAX The highest possible timeout value

Method Summary

Methods

Modifier and Type	Method and Description
int	convertToMilliseconds() Get the time value of this search timeout.
static LowPrioritySearchTimeout	create(int milliseconds) Will round millisecond value up to nearest timeout value in 2.5 second increments.
int	getRawValue() Gets the raw value of this LowPrioritySearchTimeout.
static LowPrioritySearchTimeout	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LowPrioritySearchTimeout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final LowPrioritySearchTimeout DISABLED

TWO_AND_A_HALF_SECONDS

public static final LowPrioritySearchTimeout TWO_AND_A_HALF_SECONDS

FIVE_SECONDS

public static final LowPrioritySearchTimeout FIVE_SECONDS

SEVEN_AND_A_HALF_SECONDS

public static final LowPrioritySearchTimeout SEVEN_AND_A_HALF_SECONDS

TEN_SECONDS

public static final LowPrioritySearchTimeout TEN_SECONDS

TWELVE_AND_A_HALF_SECONDS

public static final LowPrioritySearchTimeout TWELVE_AND_A_HALF_SECONDS

FIFTEEN_SECONDS

public static final LowPrioritySearchTimeout FIFTEEN_SECONDS

SEVENTEEN_AND_A_HALF_SECONDS

public static final LowPrioritySearchTimeout SEVENTEEN_AND_A_HALF_SECONDS

TWENTY_SECONDS

public static final LowPrioritySearchTimeout TWENTY_SECONDS

TWENTY_TWO_AND_A_HALF_SECONDS

public static final LowPrioritySearchTimeout TWENTY_TWO_AND_A_HALF_SECONDS

TWENTY_FIVE_SECONDS

public static final LowPrioritySearchTimeout TWENTY_FIVE_SECONDS

Field Detail

DEFAULT

public static final LowPrioritySearchTimeout DEFAULT

The timeout value set after a channel is assigned

Since:

4.0

MAX

public static final LowPrioritySearchTimeout MAX

The highest possible timeout value

Since:

4.0

Method Detail

values

public static LowPrioritySearchTimeout[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LowPrioritySearchTimeout c : LowPrioritySearchTimeout.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LowPrioritySearchTimeout valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRawValue

public int getRawValue()

Gets the raw value of this LowPrioritySearchTimeout. Applications should use the enumeration values directly.

Since:

4.0

create

public static LowPrioritySearchTimeout create(int milliseconds)

Will round millisecond value up to nearest timeout value in 2.5 second increments.

Parameters:

milliseconds - How long a search is required to run for, in millisecond units.

Returns:

A search timeout value closest to, but at least the amount of, time requested not exceeding the maximum.

Since:

4.0

convertToMilliseconds

public int convertToMilliseconds()

Get the time value of this search timeout.

Returns:

timeout in milliseconds

Since:

4.0