Enum Constant Detail

• DISABLED

  public static final HighPrioritySearchTimeout DISABLED

• TWO_AND_A_HALF_SECONDS

  public static final HighPrioritySearchTimeout TWO_AND_A_HALF_SECONDS

• FIVE_SECONDS

  public static final HighPrioritySearchTimeout FIVE_SECONDS

Field Detail

• DEFAULT

  public static final HighPrioritySearchTimeout DEFAULT

  The timeout value set after a channel is assigned

  Since:

  4.0

• MAX

  public static final HighPrioritySearchTimeout MAX

  The highest possible timeout value

  Since:

  4.0

Method Detail

• values

  public static HighPrioritySearchTimeout[] 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 (HighPrioritySearchTimeout c : HighPrioritySearchTimeout.values())
      System.out.println(c);
  

  Returns:

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

• valueOf

  public static HighPrioritySearchTimeout 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()

  Returns the raw value of this HighPrioritySearchTimeout. Applications should used the enumeration values directly.

  Since:

  4.0

• create

  public static HighPrioritySearchTimeout 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