Comparator (Step Enterprise 3.21.0 API)

java.lang.Object
- java.lang.Enum<Comparator>
- - step.artefacts.Comparator

All Implemented Interfaces:

Serializable, Comparable<Comparator>
```
public enum Comparator
extends Enum<Comparator>
```

Enum Constant Summary

Enum Constants
Enum Constant Description

EQUALS

HIGHER_THAN

LOWER_THAN

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BiFunction<Number,Number,Boolean>`	`getComparatorFunction()`
`String`	`getDescription()`
`static Comparator`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Comparator[]`	`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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - EQUALS
```
public static final Comparator EQUALS
```
  - HIGHER_THAN
```
public static final Comparator HIGHER_THAN
```
  - LOWER_THAN
```
public static final Comparator LOWER_THAN
```
- Method Detail
  - values
```
public static Comparator[] 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 (Comparator c : Comparator.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Comparator 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
  - getComparatorFunction
```
public BiFunction<Number,Number,Boolean> getComparatorFunction()
```
  - getDescription
```
public String getDescription()
```