BinSearch

java.lang.Object

java.lang.Enum<BinSearch>

com.illumon.iris.libs.primitives.BinSearch

All Implemented Interfaces:: Serializable, Comparable<BinSearch>, java.lang.constant.Constable

public enum BinSearch
extends Enum<BinSearch>

Algorithm used to resolve ties when performing a binary search.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BS_ANY`	Binary search algorithm returns any matching index.
`BS_HIGHEST`	Binary search algorithm returns the highest matching index.
`BS_LOWEST`	Binary search algorithm returns the lowest matching index.

Method Summary

Modifier and Type	Method	Description
`static BinSearch`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static BinSearch[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- BS_ANY
  
  public static final BinSearch BS_ANY
  
  Binary search algorithm returns any matching index.
- BS_HIGHEST
  
  public static final BinSearch BS_HIGHEST
  
  Binary search algorithm returns the highest matching index.
- BS_LOWEST
  
  public static final BinSearch BS_LOWEST
  
  Binary search algorithm returns the lowest matching index.
Method Details
- values
  
  public static BinSearch[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static BinSearch valueOf(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:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null