Module io.github.mmm.base

Package io.github.mmm.base.compare

Enum Class CompareOperator

java.lang.Object

java.lang.Enum<CompareOperator>

io.github.mmm.base.compare.CompareOperator

All Implemented Interfaces:

Serializable, Comparable<CompareOperator>, Constable

public enum CompareOperator
extends Enum<CompareOperator>

A CompareOperator represents an operator able to compare two given values.

Since:

1.0.0

See Also:

• evalObject(Object, Object)
• evalComparable(Comparable, Comparable)
• evalNumber(Number, Number)
• evalDouble(double, double)
• evalDelta(int)
• negate()

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
EQUAL	CompareOperator to check if objects are equal.
GREATER_OR_EQUAL	CompareOperator to check if some value is greater or equal to another.
GREATER_THAN	CompareOperator to check if some value is greater than another.
LESS_OR_EQUAL	CompareOperator to check if some value is less or equal than another.
LESS_THAN	CompareOperator to check if some value is less than another.
NOT_EQUAL	CompareOperator to check if objects are NOT equal.

Method Summary

Modifier and Type	Method	Description
<T extends Comparable<T>> boolean	evalComparable(T arg1, T arg2)	This method evaluates this CompareOperator for the given Comparable arguments.
abstract boolean	evalDelta(int delta)
boolean	evalDouble(double arg1, double arg2)	This method evaluates this CompareOperator for the given arguments.
boolean	evalNumber(Number arg1, Number arg2)	This method evaluates this CompareOperator for the given Number arguments.
boolean	evalObject(Object arg1, Object arg2)	Generic variant of evalComparable(Comparable, Comparable) that tries to convert incompatible arguments: If both arguments are same it will return evalDelta(0). If only exactly one of the arguments is null it will return evalDelta(Integer.MIN_VALUE). If both arguments are Numbers it delegates to evalNumber(Number, Number) If both arguments are Comparables: If both Comparables have different types but each of them is a standard Temporal or Date/Calendar, then one of them is converted to the other.
String	getSymbol()
abstract CompareOperator	negate()
static CompareOperator	ofSymbol(String value)	This method gets the CompareOperator for the given symbol.
String	toString()
static CompareOperator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompareOperator[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GREATER_THAN

public static final CompareOperator GREATER_THAN

CompareOperator to check if some value is greater than another.

GREATER_OR_EQUAL

public static final CompareOperator GREATER_OR_EQUAL

CompareOperator to check if some value is greater or equal to another.

LESS_THAN

public static final CompareOperator LESS_THAN

CompareOperator to check if some value is less than another.

LESS_OR_EQUAL

public static final CompareOperator LESS_OR_EQUAL

CompareOperator to check if some value is less or equal than another.

EQUAL

public static final CompareOperator EQUAL

CompareOperator to check if objects are equal.

NOT_EQUAL

public static final CompareOperator NOT_EQUAL

CompareOperator to check if objects are NOT equal.

Method Details

values

public static CompareOperator[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CompareOperator valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getSymbol

public String getSymbol()

Returns:

the symbol of this CompareOperator ("==", ">", ">=", "<", or "<=")

negate

public abstract CompareOperator negate()

Returns:

the negation of this CompareOperator that evaluates to the negated result.

evalDelta

public abstract boolean evalDelta(int delta)

Parameters:

delta - the signum of Comparable.compareTo(Object) or Integer.MIN_VALUE if the arguments are incompatible (e.g. exactly one is null or String compared with Boolean).

Returns:

the result of the CompareOperator for the given delta.

evalDouble

public boolean evalDouble(double arg1,
 double arg2)

This method evaluates this CompareOperator for the given arguments.

Parameters:

arg1 - is the first argument.

arg2 - is the second argument.

Returns:

the result of the CompareOperator applied to the given arguments.

evalComparable

public <T extends Comparable<T>> boolean evalComparable(T arg1,
 T arg2)

This method evaluates this CompareOperator for the given Comparable arguments.

Type Parameters:

T - type of the Comparable objects.

Parameters:

arg1 - is the first argument.

arg2 - is the second argument.

Returns:

the result of the CompareOperator applied to the given arguments.

See Also:

• evalObject(Object, Object)

evalObject

public boolean evalObject(Object arg1,
 Object arg2)

Generic variant of evalComparable(Comparable, Comparable) that tries to convert incompatible arguments:

• If both arguments are same it will return evalDelta(0).
• If only exactly one of the arguments is null it will return evalDelta(Integer.MIN_VALUE).
• If both arguments are Numbers it delegates to evalNumber(Number, Number)
• If both arguments are Comparables:
  • If both Comparables have different types but each of them is a standard Temporal or Date/Calendar, then one of them is converted to the other. Please note that some combinations are still invalid so e.g. LocalDate and LocalTime are not comparable.
  • If we now have two Comparables of the same type, we delegate to evalComparable(Comparable, Comparable).

Parameters:

arg1 - is the first argument.

arg2 - is the second argument.

Returns:

the result of the CompareOperator applied to the given arguments.

evalNumber

public boolean evalNumber(Number arg1,
 Number arg2)

This method evaluates this CompareOperator for the given Number arguments.

Parameters:

arg1 - is the first argument.

arg2 - is the second argument.

Returns:

the result of the CompareOperator applied to the given arguments.

See Also:

• evalObject(Object, Object)

toString

public String toString()

Overrides:

toString in class Enum<CompareOperator>

ofSymbol

public static CompareOperator ofSymbol(String value)

This method gets the CompareOperator for the given symbol.

Parameters:

value - is the symbol of the requested CompareOperator.

Returns:

the requested CompareOperator or null if no such CompareOperator exists.