AbstractValue (Permazen 4.1.6 API)

java.lang.Object
- io.permazen.parse.expr.AbstractValue

All Implemented Interfaces:

Value

Direct Known Subclasses:

AbstractLValue, BeanPropertyValue, ConstValue, FieldValue, InstanceFieldValue, JFieldValue, StaticFieldValue
```
public abstract class AbstractValue
extends Object
implements Value
```
Value implementation superclass with implementations for all methods other than get().

Field Summary
- Fields inherited from interface io.permazen.parse.expr.Value
  EQ, GT, LT, NO_VALUE

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractValue()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractValue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Value`	`add(ParseSession session, Value that)` Add or concatenate this value.
`Value`	`and(ParseSession session, Value that)` And this value.
`LValue`	`asLValue(String operation)` Verify that this instance is actually an `LValue`.
`boolean`	`checkBoolean(ParseSession session, String operation)` Evaluate this value, verify that it has boolean type, and return it.
`int`	`checkIntegral(ParseSession session, String operation)` Evaluate this value, verify that it has integral type (i.e., byte, char, short, or int), and return it.
`Object`	`checkNotNull(ParseSession session, String operation)` Evaluate this value, verify that it is not null, and return it.
`Number`	`checkNumeric(ParseSession session, String operation)` Evaluate this value, verify that it has numeric type (i.e., `Number`), and return it.
`<T> T`	`checkType(ParseSession session, String operation, Class<T> type)` Evaluate this value, verify that it has the expected type (or any sub-type), and return it.
`Value`	`compare(ParseSession session, Value that, int mask)` Ordered comparison to another value.
`Value`	`divide(ParseSession session, Value that)` Divide this value.
`Class<?>`	`getType(ParseSession session)` Get the type of this value without evaluating it.
`Value`	`invert(ParseSession session)` Bitwise invert this value.
`Value`	`lshift(ParseSession session, Value arg)` Left shift this value.
`Value`	`mod(ParseSession session, Value that)` Modulo this value.
`Value`	`multiply(ParseSession session, Value that)` Multiply this value.
`Value`	`negate(ParseSession session)` Negate this value.
`Value`	`or(ParseSession session, Value that)` Or this value.
`Value`	`rshift(ParseSession session, Value arg)` Right shift this value.
`Value`	`subtract(ParseSession session, Value that)` Subtract this value.
`Value`	`urshift(ParseSession session, Value arg)` Unsigned right shift this value.
`Value`	`xor(ParseSession session, Value that)` Xor this value.
`Value`	`xxcrement(ParseSession session, String operation, boolean increment)` Increment/decrement this value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.permazen.parse.expr.Value
get

- Constructor Detail
  - AbstractValue
```
protected AbstractValue()
```
- Method Detail
  - getType
```
public Class<?> getType(ParseSession session)
```
    Description copied from interface: Value
    
    Get the type of this value without evaluating it.
    This should perform a best-effort attempt to determine the type, but should not invoke get(). If the type is unknown, Object.class should be returned.
    
    Specified by:
    
    getType in interface Value
    
    Parameters:
    
    session - parse session
    
    Returns:
    
    the expected type of the evaluated result
  - checkNotNull
```
public Object checkNotNull(ParseSession session,
                           String operation)
```
    Description copied from interface: Value
    
    Evaluate this value, verify that it is not null, and return it.
    
    Specified by:
    
    checkNotNull in interface Value
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    Returns:
    
    the evaluated result
  - checkBoolean
```
public boolean checkBoolean(ParseSession session,
                            String operation)
```
    Description copied from interface: Value
    
    Evaluate this value, verify that it has boolean type, and return it.
    
    Specified by:
    
    checkBoolean in interface Value
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    Returns:
    
    the evaluated boolean value
  - checkNumeric
```
public Number checkNumeric(ParseSession session,
                           String operation)
```
    Description copied from interface: Value
    
    Evaluate this value, verify that it has numeric type (i.e., Number), and return it.
    
    Specified by:
    
    checkNumeric in interface Value
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    Returns:
    
    the evaluated numeric value
  - checkIntegral
```
public int checkIntegral(ParseSession session,
                         String operation)
```
    Description copied from interface: Value
    
    Evaluate this value, verify that it has integral type (i.e., byte, char, short, or int), and return it. Return its integer value.
    
    Specified by:
    
    checkIntegral in interface Value
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    Returns:
    
    the evaluated integer value
  - checkType
```
public <T> T checkType(ParseSession session,
                       String operation,
                       Class<T> type)
```
    Description copied from interface: Value
    
    Evaluate this value, verify that it has the expected type (or any sub-type), and return it. Return its value cast to that type.
    
    Specified by:
    
    checkType in interface Value
    
    Type Parameters:
    
    T - expected type
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    type - expected type
    
    Returns:
    
    the evaluated value cast to type
  - xxcrement
```
public Value xxcrement(ParseSession session,
                       String operation,
                       boolean increment)
```
    Description copied from interface: Value
    
    Increment/decrement this value. Also supports BigInteger and BigDecimal. This value must be an LValue.
    
    Specified by:
    
    xxcrement in interface Value
    
    Parameters:
    
    session - current session
    
    operation - description of operation for error messages
    
    increment - true to increment, false to decrement
    
    Returns:
    
    the adjusted value (which will not be an LValue)
  - negate
```
public Value negate(ParseSession session)
```
    Description copied from interface: Value
    
    Negate this value.
    
    Specified by:
    
    negate in interface Value
    
    Parameters:
    
    session - current session
    
    Returns:
    
    negated result
  - invert
```
public Value invert(ParseSession session)
```
    Description copied from interface: Value
    
    Bitwise invert this value.
    
    Specified by:
    
    invert in interface Value
    
    Parameters:
    
    session - current session
    
    Returns:
    
    inverted result
  - multiply
```
public Value multiply(ParseSession session,
                      Value that)
```
    Description copied from interface: Value
    
    Multiply this value.
    
    Specified by:
    
    multiply in interface Value
    
    Parameters:
    
    session - current session
    
    that - multiplicand
    
    Returns:
    
    multiplied result
  - divide
```
public Value divide(ParseSession session,
                    Value that)
```
    Description copied from interface: Value
    
    Divide this value.
    
    Specified by:
    
    divide in interface Value
    
    Parameters:
    
    session - current session
    
    that - divisor
    
    Returns:
    
    divided result
  - mod
```
public Value mod(ParseSession session,
                 Value that)
```
    Description copied from interface: Value
    
    Modulo this value.
    
    Specified by:
    
    mod in interface Value
    
    Parameters:
    
    session - current session
    
    that - divisor
    
    Returns:
    
    remaindered result
  - add
```
public Value add(ParseSession session,
                 Value that)
```
    Description copied from interface: Value
    
    Add or concatenate this value.
    
    Specified by:
    
    add in interface Value
    
    Parameters:
    
    session - current session
    
    that - addend
    
    Returns:
    
    added result
  - subtract
```
public Value subtract(ParseSession session,
                      Value that)
```
    Description copied from interface: Value
    
    Subtract this value. Also supports Set and NavigableSet difference.
    
    Specified by:
    
    subtract in interface Value
    
    Parameters:
    
    session - current session
    
    that - subtrahend
    
    Returns:
    
    subtracted result
  - lshift
```
public Value lshift(ParseSession session,
                    Value arg)
```
    Description copied from interface: Value
    
    Left shift this value.
    
    Specified by:
    
    lshift in interface Value
    
    Parameters:
    
    session - current session
    
    arg - shift amount
    
    Returns:
    
    shifted result
  - rshift
```
public Value rshift(ParseSession session,
                    Value arg)
```
    Description copied from interface: Value
    
    Right shift this value.
    
    Specified by:
    
    rshift in interface Value
    
    Parameters:
    
    session - current session
    
    arg - shift amount
    
    Returns:
    
    shifted result
  - urshift
```
public Value urshift(ParseSession session,
                     Value arg)
```
    Description copied from interface: Value
    
    Unsigned right shift this value.
    
    Specified by:
    
    urshift in interface Value
    
    Parameters:
    
    session - current session
    
    arg - shift amount
    
    Returns:
    
    shifted result
  - and
```
public Value and(ParseSession session,
                 Value that)
```
    Description copied from interface: Value
    
    And this value. Also supports Set and NavigableSet intersection.
    
    Specified by:
    
    and in interface Value
    
    Parameters:
    
    session - current session
    
    that - and value
    
    Returns:
    
    and'ed result
  - or
```
public Value or(ParseSession session,
                Value that)
```
    Description copied from interface: Value
    
    Or this value. Also supports Set and NavigableSet union.
    
    Specified by:
    
    or in interface Value
    
    Parameters:
    
    session - current session
    
    that - or value
    
    Returns:
    
    or'ed result
  - xor
```
public Value xor(ParseSession session,
                 Value that)
```
    Description copied from interface: Value
    
    Xor this value. Also supports Set and NavigableSet symmetric difference.
    
    Specified by:
    
    xor in interface Value
    
    Parameters:
    
    session - current session
    
    that - xor value
    
    Returns:
    
    exclusive or'ed result
  - compare
```
public Value compare(ParseSession session,
                     Value that,
                     int mask)
```
    Description copied from interface: Value
    
    Ordered comparison to another value. Supports numeric and Comparable comparison.
    
    Specified by:
    
    compare in interface Value
    
    Parameters:
    
    session - current session
    
    that - value to compare to
    
    mask - bit mask with bits Value.LT, Value.GT, and/or Value.EQ
    
    Returns:
    
    boolean value which will be true if the comparison is true
  - asLValue
```
public LValue asLValue(String operation)
```
    Description copied from interface: Value
    
    Verify that this instance is actually an LValue.
    
    Specified by:
    
    asLValue in interface Value
    
    Parameters:
    
    operation - description of operation for error messages
    
    Returns:
    
    this instance cast to LValue

Class AbstractValue

Field Summary

Fields inherited from interface io.permazen.parse.expr.Value

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.permazen.parse.expr.Value

Constructor Detail

AbstractValue

Method Detail

getType

checkNotNull

checkBoolean

checkNumeric

checkIntegral

checkType

xxcrement

negate

invert

multiply

divide

mod

add

subtract

lshift

rshift

urshift

and

or

xor

compare

asLValue