ArithmeticOperator

java.lang.Object
- java.lang.Enum<ArithmeticOperator>
- - com.tameif.tame.lang.ArithmeticOperator

public enum ArithmeticOperator
extends java.lang.Enum<ArithmeticOperator>

Arithmetic operators.

Author:: Matthew Tropiano

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABSOLUTE`
`ADD`
`DIVIDE`
`EQUALS`
`GREATER`
`GREATER_OR_EQUAL`
`LESS`
`LESS_OR_EQUAL`
`LOGICAL_AND`
`LOGICAL_NOT`
`LOGICAL_OR`
`LOGICAL_XOR`
`MODULO`
`MULTIPLY`
`NEGATE`
`NOT_EQUALS`
`POWER`
`STRICT_EQUALS`
`STRICT_NOT_EQUALS`
`SUBTRACT`

Field Summary

Fields
Modifier and Type Field and Description

static ArithmeticOperator[] VALUES
Array of arithmetic operators to avoid memory allocations.

Fields
Modifier and Type	Field and Description
`static ArithmeticOperator[]`	`VALUES` Array of arithmetic operators to avoid memory allocations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Value`	`doOperation(Value value)` Performs the action on one value.
`Value`	`doOperation(Value value1, Value value2)` Performs the action on two values.
`int`	`getPrecedence()` Operator precedence.
`java.lang.String`	`getSymbol()` Operator symbol.
`boolean`	`isBinary()` IS this a binary operator?
`boolean`	`isRightAssociative()` Is this operator right-associative?
`static ArithmeticOperator`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ArithmeticOperator[]`	`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
  - ABSOLUTE
```
public static final ArithmeticOperator ABSOLUTE
```
  - ADD
```
public static final ArithmeticOperator ADD
```
  - DIVIDE
```
public static final ArithmeticOperator DIVIDE
```
  - EQUALS
```
public static final ArithmeticOperator EQUALS
```
  - GREATER
```
public static final ArithmeticOperator GREATER
```
  - GREATER_OR_EQUAL
```
public static final ArithmeticOperator GREATER_OR_EQUAL
```
  - LESS
```
public static final ArithmeticOperator LESS
```
  - LESS_OR_EQUAL
```
public static final ArithmeticOperator LESS_OR_EQUAL
```
  - LOGICAL_AND
```
public static final ArithmeticOperator LOGICAL_AND
```
  - LOGICAL_NOT
```
public static final ArithmeticOperator LOGICAL_NOT
```
  - LOGICAL_OR
```
public static final ArithmeticOperator LOGICAL_OR
```
  - LOGICAL_XOR
```
public static final ArithmeticOperator LOGICAL_XOR
```
  - MODULO
```
public static final ArithmeticOperator MODULO
```
  - MULTIPLY
```
public static final ArithmeticOperator MULTIPLY
```
  - NEGATE
```
public static final ArithmeticOperator NEGATE
```
  - NOT_EQUALS
```
public static final ArithmeticOperator NOT_EQUALS
```
  - POWER
```
public static final ArithmeticOperator POWER
```
  - STRICT_EQUALS
```
public static final ArithmeticOperator STRICT_EQUALS
```
  - STRICT_NOT_EQUALS
```
public static final ArithmeticOperator STRICT_NOT_EQUALS
```
  - SUBTRACT
```
public static final ArithmeticOperator SUBTRACT
```
- Field Detail
  - VALUES
```
public static final ArithmeticOperator[] VALUES
```
    Array of arithmetic operators to avoid memory allocations.
- Method Detail
  - values
```
public static ArithmeticOperator[] 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 (ArithmeticOperator c : ArithmeticOperator.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ArithmeticOperator valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getSymbol
```
public java.lang.String getSymbol()
```
    Operator symbol.
    
    Returns:
    
    a string representation of this operator's.
  - getPrecedence
```
public int getPrecedence()
```
    Operator precedence.
    
    Returns:
    
    an operator precedence value. Higher has earlier ordering.
  - isBinary
```
public boolean isBinary()
```
    IS this a binary operator?
    
    Returns:
    
    true if so, false if not.
  - isRightAssociative
```
public boolean isRightAssociative()
```
    Is this operator right-associative?
    
    Returns:
    
    true if so, false if not.
  - doOperation
```
public Value doOperation(Value value)
```
    Performs the action on one value.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the resultant value.
    
    Throws:
    
    java.lang.ArithmeticException - If an arithmetic exception occurs.
  - doOperation
```
public Value doOperation(Value value1,
                         Value value2)
```
    Performs the action on two values.
    
    Parameters:
    
    value1 - the first value.
    
    value2 - the second value.
    
    Returns:
    
    the resultant value.
    
    Throws:
    
    java.lang.ArithmeticException - If an arithmetic exception occurs.

Enum ArithmeticOperator

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ABSOLUTE

ADD

DIVIDE

EQUALS

GREATER

GREATER_OR_EQUAL

LESS

LESS_OR_EQUAL

LOGICAL_AND

LOGICAL_NOT

LOGICAL_OR

LOGICAL_XOR

MODULO

MULTIPLY

NEGATE

NOT_EQUALS

POWER

STRICT_EQUALS

STRICT_NOT_EQUALS

SUBTRACT

Field Detail

VALUES

Method Detail

values

valueOf

getSymbol

getPrecedence

isBinary

isRightAssociative

doOperation

doOperation