Property.Operator (SpongeAPI 7.3.0 API)

java.lang.Object
- java.lang.Enum<Property.Operator>
- - org.spongepowered.api.data.Property.Operator

All Implemented Interfaces:

Serializable, Comparable<Property.Operator>

Enclosing interface:

Property<K,V>
```
public static enum Property.Operator
extends Enum<Property.Operator>
```
Operator used to indicate to a query what operation to use when comparing this property with properties present on an item stack.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DELEGATE` No operator, use the operator from the other property when comparing.
`EQUAL` Use the `.equals()` method.
`GEQUAL` Use `.compareTo()` and match if target is greater than or equal to supplied operand.
`GREATER` Use `.compareTo()` amd match if target is greater than supplied operand.
`LEQUAL` Use `.compareTo()` amd match if target is less than or equal to the supplied operand.
`LESS` Use `.compareTo()` amd match if target is less than the supplied operand.
`NOTEQUAL` Use the `.equals()` method but match if the result is false.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract boolean`	`apply(Property<?,?> operand1, Property<?,?> operand2)` Stub for subclasses to implement their logic.
`boolean`	`compare(Property<?,?> operand1, Property<?,?> operand2)` Compare the two operands by applying this operator infix with respect to them.
`static Property.Operator`	`defaultOperator()` Gets the default operator to use if none is specified.
`static Property.Operator`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Property.Operator[]`	`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
  - DELEGATE
```
public static final Property.Operator DELEGATE
```
    No operator, use the operator from the other property when comparing. If both properties have their operator set as DELEGATE, then comparison will always return false.
  - EQUAL
```
public static final Property.Operator EQUAL
```
    Use the .equals() method.
  - NOTEQUAL
```
public static final Property.Operator NOTEQUAL
```
    Use the .equals() method but match if the result is false.
  - GREATER
```
public static final Property.Operator GREATER
```
    Use .compareTo() amd match if target is greater than supplied operand.
  - GEQUAL
```
public static final Property.Operator GEQUAL
```
    Use .compareTo() and match if target is greater than or equal to supplied operand.
  - LESS
```
public static final Property.Operator LESS
```
    Use .compareTo() amd match if target is less than the supplied operand.
  - LEQUAL
```
public static final Property.Operator LEQUAL
```
    Use .compareTo() amd match if target is less than or equal to the supplied operand.
- Method Detail
  - values
```
public static Property.Operator[] 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 (Property.Operator c : Property.Operator.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Property.Operator 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
  - compare
```
public final boolean compare(@Nullable
                             Property<?,?> operand1,
                             @Nullable
                             Property<?,?> operand2)
```
    Compare the two operands by applying this operator infix with respect to them. For example, if this object is GREATER then calling this method with object1 and object2 would effectively return:
    
    returnValue = object1 > object2;
    
    Parameters:
    
    operand1 - First operand
    
    operand2 - Second operand
    
    Returns:
    
    First operand's comparison to second
  - apply
```
protected abstract boolean apply(Property<?,?> operand1,
                                 Property<?,?> operand2)
```
    Stub for subclasses to implement their logic. Used so we can get the null comparison logic out of the way first and then only proceed with comparison if both arguments are non-null.
    
    Parameters:
    
    operand1 - First operand
    
    operand2 - Second operand
    
    Returns:
    
    First operand's comparison to second
  - defaultOperator
```
public static Property.Operator defaultOperator()
```
    Gets the default operator to use if none is specified.
    
    Returns:
    
    the default operator

Enum Property.Operator

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DELEGATE

EQUAL

NOTEQUAL

GREATER

GEQUAL

LESS

LEQUAL

Method Detail

values

valueOf

compare

apply

defaultOperator