AbstractCalculator (JCalc API)

java.lang.Object
- org.jdice.calc.AbstractCalculator<CALC>

Type Parameters:
CALC -

Direct Known Subclasses:

Calc, CalcTrig
```
public abstract class AbstractCalculator<CALC>
extends java.lang.Object
```
Abstract class that concrete calculator extends

Constructor Summary

Constructors
Constructor and Description
`AbstractCalculator()`
`AbstractCalculator(Num value)`
`AbstractCalculator(java.lang.Object value)` Constructor
`AbstractCalculator(java.lang.String value)`
`AbstractCalculator(java.lang.String value, char decimalSeparator)`

Method Summary

Methods
Modifier and Type	Method and Description
`CALC`	`append(AbstractCalculator expression)` Copy calculator expression into this expression within brackets
`CALC`	`append(AbstractCalculator expression, boolean withinBrackets)` Copy expression from given calculator into this expression within or without brackets
`CALC`	`append(java.lang.Class<? extends Function> function, java.lang.Object... values)` Append function with value to expression.
`CALC`	`append(java.lang.Class<? extends Operator> operator)` Append operator to expression
`CALC`	`append(java.lang.Class<? extends Operator> operator, Num value)` Append operator and number to expression
`CALC`	`append(java.lang.Class<? extends Operator> operator, java.lang.Object value)` Append operator and number to expression
`CALC`	`append(java.lang.Class<? extends Operator> operator, java.lang.String value, char decimalSeparator)` Append operator and parsed String value with custom decimal separator used in String representation of value
`CALC`	`append(CList infix, boolean withinBrackets)` Copy infix expression into this expression within or without brackets
`<T extends AbstractCalculator> T`	`bind(java.lang.Class<T> clazz)` Bind another Calculator class functionalities to expression.
`Num`	`calc()` Calculate prepared expression
`<T> T`	`calc(java.lang.Class<T> toClass)` Calculate prepared expression and convert to object of given class
`Num`	`calculate()` Calculate prepared expression
`Num`	`calcWithSteps(boolean showDetails)` Calculate expression and track calculation steps accessible with `getCalculationSteps()`
`CALC`	`cb()` Close bracket
`CALC`	`closeBracket()` Close bracket
`CALC`	`expression(java.lang.String expression)` Parse and append given expression to existing expression
`CALC`	`expression(java.lang.String expression, java.lang.Object... values)` Parse and append given expression to existing expression String representation of expression that will be parsed with unknown variables.
`java.util.LinkedList<java.lang.String>`	`getCalculationSteps()` Get calculation steps if calculation is initiated with `calcWithSteps(boolean)`
`char`	`getDecimalSeparator()` Get decimal separator used throughout expression
`char`	`getGroupingSeparator()` Get grouping separator used throughout expression
`java.lang.String`	`getInfix()` Get infix (common arithmetic and logical expression notation) representation of given expression
`java.lang.String`	`getPostfix()` Convert defined expression to postfix `String`
`Properties`	`getProperties()` Get defined properties
`OperationRegister`	`getRegisteredOperations()` List registered local scoped operations.
`Num`	`getResult()` Return copy of calculated result
`Rounding`	`getRoundingMode()` Get rounding mode used throughout expression
`java.lang.Integer`	`getScale()` Get scale mode used throughout expression
`protected abstract CALC`	`getThis()` Return reference of subclass
`boolean`	`hasCalculationSteps()` Check if calculation steps are remembered during calculation.
`boolean`	`hasResult()` Check whether the calculation is made according to a expression
`boolean`	`hasStripTrailingZeros()`
`CALC`	`ob()` Open bracket
`CALC`	`openBracket()` Open bracket
`CALC`	`openBracket(double value)` Open bracket and add value after.
`CALC`	`openBracket(float value)` Open bracket and add value after.
`CALC`	`openBracket(int value)` Open bracket and add value after.
`CALC`	`openBracket(long value)` Open bracket and add value after.
`CALC`	`openBracket(Num value)` Open bracket and add value after.
`CALC`	`openBracket(java.lang.Object value)` Open bracket and add value after.
`CALC`	`openBracket(short value)` Open bracket and add value after.
`CALC`	`openBracket(java.lang.String value)` Open bracket and add value after.
`CALC`	`openBracket(java.lang.String value, char decimalSeparator)` Open bracket and add value after.
`CALC`	`register(java.lang.Class<? extends Operation> operationClass)` Provide custom `Operator` or `Function` inside scope of this instance, that can be used during expression parsing.
`CALC`	`setDecimalSeparator(char decimalSeparator)` Set decimal separator for entire expression
`CALC`	`setGroupingSeparator(char decimalSeparator)` Set number grouping separator for entire expression
`CALC`	`setProperties(Properties properties)` Set proeprties
`CALC`	`setRoundingMode(Rounding roundingMode)` Set rounding mode for entire expression
`CALC`	`setScale(java.lang.Integer scale)` Set scale for entire expression
`CALC`	`setStripTrailingZeros(boolean stripTrailingZeros)`
`java.lang.String`	`toString()`
`CALC`	`val(double value)` Append value to expression
`CALC`	`val(float value)` Append value to expression
`CALC`	`val(int value)` Append value to expression
`CALC`	`val(long value)` Append value to expression
`CALC`	`val(Num value)` Append value to expression
`CALC`	`val(java.lang.Object value)` Append value to expression
`CALC`	`val(java.lang.Object value, java.lang.Class<? extends NumConverter> converter)` Append value to expression
`CALC`	`val(short value)` Append value to expression
`CALC`	`val(java.lang.String value)` Append String value to expression that will be parsed to `Num`
`CALC`	`val(java.lang.String value, char decimalSeparator)` Append String value to expression that will be parsed to `Num` with defined decimal separator

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

- Constructor Detail
  - AbstractCalculator
```
public AbstractCalculator()
```
  - AbstractCalculator
```
public AbstractCalculator(java.lang.Object value)
```
    Constructor
    
    Parameters:
    value - can be any object than Num can work with
  - AbstractCalculator
```
public AbstractCalculator(Num value)
```
  - AbstractCalculator
```
public AbstractCalculator(java.lang.String value)
```
  - AbstractCalculator
```
public AbstractCalculator(java.lang.String value,
                  char decimalSeparator)
```
- Method Detail
  - getThis
```
protected abstract CALC getThis()
```
    Return reference of subclass
    
    Returns:
  - register
```
public CALC register(java.lang.Class<? extends Operation> operationClass)
```
    Provide custom Operator or Function inside scope of this instance, that can be used during expression parsing. With registration of custom operation it's possible to override existing default operation implementation. Because during calculation API first scan scoped (registered) operation and after that default operation implementation inside Cache
    
    Parameters:
    operationClass -
    
    Returns:
  - getRegisteredOperations
```
public OperationRegister getRegisteredOperations()
```
    List registered local scoped operations.
    
    Returns:
  - val
```
public CALC val(short value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(int value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(long value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(float value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(double value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(java.lang.Object value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(java.lang.Object value,
       java.lang.Class<? extends NumConverter> converter)
```
    Append value to expression
    
    Parameters:
    value - custom type value
    converter - class for convert custom type to Num
    
    Returns:
  - val
```
public CALC val(java.lang.String value)
```
    Append String value to expression that will be parsed to Num
    
    Parameters:
    value -
    
    Returns:
  - val
```
public CALC val(java.lang.String value,
       char decimalSeparator)
```
    Append String value to expression that will be parsed to Num with defined decimal separator
    
    Parameters:
    value - String representation of number
    decimalSeparator - used in string representation of number
    
    Returns:
  - val
```
public CALC val(Num value)
```
    Append value to expression
    
    Parameters:
    value -
    
    Returns:
  - append
```
public CALC append(AbstractCalculator expression)
```
    Copy calculator expression into this expression within brackets
    
    Parameters:
    expression -
    
    Returns:
  - append
```
public CALC append(AbstractCalculator expression,
          boolean withinBrackets)
```
    Copy expression from given calculator into this expression within or without brackets
    
    Parameters:
    expression -
    withinBrackets -
    
    Returns:
  - append
```
public CALC append(CList infix,
          boolean withinBrackets)
```
    Copy infix expression into this expression within or without brackets
    
    Parameters:
    infix -
    withinBrackets -
    
    Returns:
  - append
```
public CALC append(java.lang.Class<? extends Operator> operator)
```
    Append operator to expression
    
    Parameters:
    operator -
    
    Returns:
  - append
```
public CALC append(java.lang.Class<? extends Operator> operator,
          java.lang.Object value)
```
    Append operator and number to expression
    
    Parameters:
    operator -
    value -
    
    Returns:
  - append
```
public CALC append(java.lang.Class<? extends Operator> operator,
          java.lang.String value,
          char decimalSeparator)
```
    Append operator and parsed String value with custom decimal separator used in String representation of value
    
    Parameters:
    operator -
    value -
    decimalSeparator -
    
    Returns:
  - append
```
public CALC append(java.lang.Class<? extends Operator> operator,
          Num value)
```
    Append operator and number to expression
    
    Parameters:
    operator -
    value -
    
    Returns:
  - append
```
public CALC append(java.lang.Class<? extends Function> function,
          java.lang.Object... values)
```
    Append function with value to expression.
    e.g. Abs.class, -5 => abs(-5)
    
    Parameters:
    function -
    values - can accept any object that Num can work with
    
    Returns:
    See Also:
    Function}
  - expression
```
public CALC expression(java.lang.String expression)
                throws java.text.ParseException
```
    Parse and append given expression to existing expression
    
    Parameters:
    expression -
    
    Returns:
    
    Throws:
    
    java.text.ParseException
  - expression
```
public CALC expression(java.lang.String expression,
              java.lang.Object... values)
                throws java.text.ParseException
```
    Parse and append given expression to existing expression String representation of expression that will be parsed with unknown variables. It is possible to define name of Num with Num.setName(String) then name will be matched with name of unknown variable. Otherwise unknown variable will be matched by declared order.
    e.g. X + 5 - (2 * X - Y)
    
    Parameters:
    expression -
    
    Returns:
    
    Throws:
    
    java.text.ParseException
  - ob
```
public CALC ob()
```
    Open bracket
    
    Returns:
  - openBracket
```
public CALC openBracket()
```
    Open bracket
    
    Returns:
  - openBracket
```
public CALC openBracket(short value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(int value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(long value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(float value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(double value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(java.lang.Object value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(java.lang.String value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(java.lang.String value,
               char decimalSeparator)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - openBracket
```
public CALC openBracket(Num value)
```
    Open bracket and add value after. e.g. (5
    
    Parameters:
    value -
    
    Returns:
  - cb
```
public CALC cb()
```
    Close bracket
    
    Returns:
  - closeBracket
```
public CALC closeBracket()
```
    Close bracket
    
    Returns:
  - getProperties
```
public Properties getProperties()
```
    Get defined properties
    
    Returns:
  - setProperties
```
public CALC setProperties(Properties properties)
```
    Set proeprties
    
    Parameters:
    properties -
    
    Returns:
  - setScale
```
public CALC setScale(java.lang.Integer scale)
```
    Set scale for entire expression
    
    Parameters:
    scale -
    
    Returns:
  - getScale
```
public java.lang.Integer getScale()
```
    Get scale mode used throughout expression
    
    Returns:
  - setRoundingMode
```
public CALC setRoundingMode(Rounding roundingMode)
```
    Set rounding mode for entire expression
    
    Parameters:
    roundingMode -
    
    Returns:
  - getRoundingMode
```
public Rounding getRoundingMode()
```
    Get rounding mode used throughout expression
    
    Returns:
  - setDecimalSeparator
```
public CALC setDecimalSeparator(char decimalSeparator)
```
    Set decimal separator for entire expression
    
    Parameters:
    decimalSeparator -
    
    Returns:
  - getDecimalSeparator
```
public char getDecimalSeparator()
```
    Get decimal separator used throughout expression
    
    Returns:
  - setGroupingSeparator
```
public CALC setGroupingSeparator(char decimalSeparator)
```
    Set number grouping separator for entire expression
    
    Parameters:
    decimalSeparator -
    
    Returns:
  - getGroupingSeparator
```
public char getGroupingSeparator()
```
    Get grouping separator used throughout expression
    
    Returns:
  - hasStripTrailingZeros
```
public boolean hasStripTrailingZeros()
```
  - setStripTrailingZeros
```
public CALC setStripTrailingZeros(boolean stripTrailingZeros)
```
  - calc
```
public Num calc()
```
    Calculate prepared expression
    
    Returns:
    See Also:
    #calculate()}, #calcWithSteps(boolean)}, #getResult()}
  - calc
```
public <T> T calc(java.lang.Class<T> toClass)
```
    Calculate prepared expression and convert to object of given class
    
    Returns:
    See Also:
    #calculate()}, #calcWithSteps(boolean)}, #getResult()}, Num#toObject(Class)}
  - calculate
```
public Num calculate()
```
    Calculate prepared expression
    
    Returns:
    See Also:
    #calc()}, #calcWithSteps(boolean)}, #getResult()}
  - calcWithSteps
```
public Num calcWithSteps(boolean showDetails)
```
    Calculate expression and track calculation steps accessible with getCalculationSteps()
    
    Returns:
  - bind
```
public <T extends AbstractCalculator> T bind(java.lang.Class<T> clazz)
```
    Bind another Calculator class functionalities to expression. Way to combine two different implementation of calculators
    
    Parameters:
    clazz -
    
    Returns:
  - getPostfix
```
public java.lang.String getPostfix()
```
    Convert defined expression to postfix String
    
    Returns:
  - getInfix
```
public java.lang.String getInfix()
```
    Get infix (common arithmetic and logical expression notation) representation of given expression
    
    Returns:
    See Also:
    getPostfix()}
  - hasResult
```
public boolean hasResult()
```
    Check whether the calculation is made according to a expression
    
    Returns:
    See Also:
    getResult()}
  - getResult
```
public Num getResult()
```
    Return copy of calculated result
    
    Returns:
    See Also:
    hasResult()}
  - hasCalculationSteps
```
public boolean hasCalculationSteps()
```
    Check if calculation steps are remembered during calculation.
    
    Returns:
    See Also:
    getCalculationSteps()}
  - getCalculationSteps
```
public java.util.LinkedList<java.lang.String> getCalculationSteps()
```
    Get calculation steps if calculation is initiated with calcWithSteps(boolean)
    
    Returns:
    See Also:
    {@link}
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractCalculator<CALC>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCalculator

AbstractCalculator

AbstractCalculator

AbstractCalculator

AbstractCalculator

Method Detail

getThis

register

getRegisteredOperations

val

val

val

val

val

val

val

val

val

val

append

append

append

append

append

append

append

append

expression

expression

ob

openBracket

openBracket

openBracket

openBracket

openBracket

openBracket

openBracket

openBracket

openBracket

openBracket

cb

closeBracket

getProperties

setProperties

setScale

getScale

setRoundingMode

getRoundingMode

setDecimalSeparator

getDecimalSeparator

setGroupingSeparator

getGroupingSeparator

hasStripTrailingZeros

setStripTrailingZeros

calc

calc

calculate

calcWithSteps

bind

getPostfix

getInfix

hasResult

getResult

hasCalculationSteps

getCalculationSteps

toString