CompareOperator (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- java.lang.Enum<CompareOperator>
- - net.sf.mmm.util.lang.api.CompareOperator

All Implemented Interfaces:

Serializable, Comparable<CompareOperator>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>, NlsObject
```
public enum CompareOperator
extends Enum<CompareOperator>
implements SimpleDatatype<String>, NlsObject
```
A CompareOperator represents a function that compares two given values.

Since:

6.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants
Enum Constant and 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`.

Field Summary

Fields
Modifier and Type Field and Description

private String title

private String value
- Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject
  KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Fields
Modifier and Type	Field and Description
`private String`	`title`
`private String`	`value`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`private Object`	`convert(Object object, Class<?> otherType)`
`abstract boolean`	`eval(double arg1, double arg2)` This method evaluates this `CompareOperator` for the given arguments.
`boolean`	`eval(Object arg1, Object arg2)` This method evaluates this `CompareOperator` for the given arguments.
`private boolean`	`evalComparable(Comparable arg1, Comparable arg2)` This method handles `eval(Object, Object)` for two `Comparable`s.
`static CompareOperator`	`fromValue(String value)` This method gets the `CompareOperator` for the given `symbol`.
`private static NlsBundleUtilCoreRoot`	`getBundle()`
`String`	`getValue()` This method gets the symbol of the `CompareOperator`.
`(package private) boolean`	`isTrueIfEquals()`
`(package private) boolean`	`isTrueIfGreater()`
`(package private) boolean`	`isTrueIfLess()`
`abstract CompareOperator`	`negate()`
`String`	`toString()` Returns the official `String` representation of this `Datatype`.
`static CompareOperator`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CompareOperator[]`	`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, valueOf

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

Methods inherited from interface net.sf.mmm.util.nls.api.NlsObject
toNlsMessage

- Enum Constant Detail
  - 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.
- Field Detail
  - value
```
private final String value
```
  - title
```
private final String title
```
- Method Detail
  - values
```
public static CompareOperator[] 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 (CompareOperator c : CompareOperator.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CompareOperator 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
  - isTrueIfEquals
```
boolean isTrueIfEquals()
```
    Returns:
    
    true if this CompareOperator evaluates to true for Objects that are equal to each other, false otherwise.
  - isTrueIfLess
```
boolean isTrueIfLess()
```
    Returns:
    
    true if this CompareOperator evaluates to true in case the first argument is less than the second, false otherwise.
  - isTrueIfGreater
```
boolean isTrueIfGreater()
```
    Returns:
    
    true if this CompareOperator evaluates to true in case the first argument is greater than the second, false otherwise.
  - getValue
```
public String getValue()
```
    This method gets the symbol of the CompareOperator. E.g. "==", ">", ">=", etc.
    
    Specified by:
    
    getValue in interface AttributeReadValue<String>
    
    Specified by:
    
    getValue in interface SimpleDatatype<String>
    
    Returns:
    
    the comparator symbol.
  - getBundle
```
private static NlsBundleUtilCoreRoot getBundle()
```
    Returns:
    
    the instance of NlsBundleUtilCoreRoot.
  - eval
```
public abstract boolean eval(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.
  - negate
```
public abstract CompareOperator negate()
```
    Returns:
    
    the negation of this CompareOperator that evaluates to the negated result.
    
    Since:
    
    7.1.0
  - convert
```
private Object convert(Object object,
                       Class<?> otherType)
```
    Parameters:
    
    object - is the value to convert.
    
    otherType - the type of the value to compare that differs from the type
    
    Returns:
    
    a simpler representation of value or the same value if on simpler type is known.
    
    See Also:
    
    ComparatorHelper.convert(Object, Class)
  - evalComparable
```
private boolean evalComparable(Comparable arg1,
                               Comparable arg2)
```
    This method handles eval(Object, Object) for two Comparables.
    
    Parameters:
    
    arg1 - is the first argument.
    
    arg2 - is the second argument.
    
    Returns:
    
    the result of the CompareOperator applied to the given arguments.
  - eval
```
public boolean eval(Object arg1,
                    Object 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.
  - toString
```
public String toString()
```
    Description copied from interface: Datatype
    
    Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
    ATTENTION:
    This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.
    
    Specified by:
    
    toString in interface Datatype
    
    Overrides:
    
    toString in class Enum<CompareOperator>
    
    Returns:
    
    the official String representation to display the value of this Datatype.
  - fromValue
```
public static CompareOperator fromValue(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.

Enum CompareOperator

Enum Constant Summary

Field Summary

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.mmm.util.nls.api.NlsObject

Enum Constant Detail

GREATER_THAN

GREATER_OR_EQUAL

LESS_THAN

LESS_OR_EQUAL

EQUAL

NOT_EQUAL

Field Detail

value

title

Method Detail

values

valueOf

isTrueIfEquals

isTrueIfLess

isTrueIfGreater

getValue

getBundle

eval

negate

convert

evalComparable

eval

toString

fromValue