AbstractCalculator (JCalc API)

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

Type Parameters:
CALC -

Direct Known Subclasses:

Calculator, TrigCalculator
```
public abstract class AbstractCalculator<CALC>
extends java.lang.Object
```
Abstract class which is extended by concrete calculator (e.g. Calculator

Constructor Summary

Constructors
Constructor and Description

AbstractCalculator()

Constructors
Constructor and Description
`AbstractCalculator()`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends AbstractCalculator> T`	`bind(java.lang.Class<T> clazz)` Bind another Calculator class functionalities to expression.
`Num`	`calculate()` Calculate prepared expression.
`CALC`	`closeBracket()` Close bracket
`CALC`	`expression(AbstractCalculator expression, boolean withinBrackets)` Copy expression from given calculator into this expression within or without brackets
`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.
`CALC`	`function(java.lang.Class<? extends Function> function, java.lang.Object... values)` Append function with value to expression.
`Num`	`getCalculatedValue()` Return calculated value
`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
`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
`java.util.LinkedList<Step>`	`getTracedSteps()` Get calculation steps if `isTracingSteps()` is TRUE
`UseExtension`	`getUsedExtensions()` List registered local scoped operations.
`boolean`	`hasStripTrailingZeros()`
`boolean`	`isCalculated()` Check whether the calculation is made according to a expression
`boolean`	`isTracingSteps()` Check if is tracking steps enabled or disabled.
`CALC`	`openBracket()` Open bracket
`CALC`	`operator(java.lang.Class<? extends Operator> operator)` Append operator to expression
`protected CALC`	`operator(java.lang.Class<? extends Operator> operator, java.lang.Object value)` Append operator and number to expression
`protected CALC`	`operator(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`	`setDecimalSeparator(char decimalSeparator)` Set decimal separator for entire expression
`CALC`	`setGroupingSeparator(char decimalSeparator)` Set number grouping separator for entire expression
`CALC`	`setInfix(CList infix)` Provide infix list for this calculator.
`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
`void`	`setSteps(java.util.LinkedList<Step> calculationSteps)`
`CALC`	`setStripTrailingZeros(boolean stripTrailingZeros)`
`CALC`	`setTracingSteps(boolean trackSteps)` If set to TRUE it will track step of calculation.
`java.lang.String`	`toString()`
`CALC`	`use(java.lang.Class<? extends Extension> operationClass)` Use custom `Operator` or `Function` inside scope of this calculation, which can be used during parsing 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(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()
```
- Method Detail
  - getThis
```
protected abstract CALC getThis()
```
    Return reference of subclass
    
    Returns:
  - use
```
public CALC use(java.lang.Class<? extends Extension> operationClass)
```
    Use custom Operator or Function inside scope of this calculation, which can be used during parsing expression. With using custom extension it's possible to override existing extension from global scope. Because during calculation API first scan scoped (locally used) extensions and after that search in global extension from CacheExtension
    
    Parameters:
    operationClass -
    
    Returns:
  - getUsedExtensions
```
public UseExtension getUsedExtensions()
```
    List registered local scoped operations.
    
    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,
       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:
  - operator
```
public final CALC operator(java.lang.Class<? extends Operator> operator)
```
    Append operator to expression
    
    Parameters:
    operator -
    
    Returns:
  - operator
```
protected final CALC operator(java.lang.Class<? extends Operator> operator,
            java.lang.Object value)
```
    Append operator and number to expression
    
    Parameters:
    operator -
    value -
    
    Returns:
  - operator
```
protected final CALC operator(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:
  - function
```
public final CALC function(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 final 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 final 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 -
    values - that match unknown variable by name or by order
    
    Returns:
    AbstractCalculator
    
    Throws:
    
    java.text.ParseException
  - expression
```
public CALC expression(AbstractCalculator expression,
              boolean withinBrackets)
```
    Copy expression from given calculator into this expression within or without brackets
    
    Parameters:
    expression -
    withinBrackets -
    
    Returns:
  - openBracket
```
public CALC openBracket()
```
    Open 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)
```
  - setTracingSteps
```
public CALC setTracingSteps(boolean trackSteps)
```
    If set to TRUE it will track step of calculation. And provide those steps by getTracedSteps()
    
    Parameters:
    trackSteps -
    
    Returns:
  - isTracingSteps
```
public boolean isTracingSteps()
```
    Check if is tracking steps enabled or disabled.
    
    Returns:
    See Also:
    #setTracingSteps(boolean)}
  - getTracedSteps
```
public java.util.LinkedList<Step> getTracedSteps()
```
    Get calculation steps if isTracingSteps() is TRUE
    
    Returns:
    See Also:
    {@link}
  - calculate
```
public Num calculate()
```
    Calculate prepared expression. For tracking calculation
    
    Returns:
    See Also:
    #calculate()}, #getCalculatedValue()}
  - 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()}
  - setInfix
```
public final CALC setInfix(CList infix)
```
    Provide infix list for this calculator.
    
    Parameters:
    infix -
    
    Returns:
  - isCalculated
```
public boolean isCalculated()
```
    Check whether the calculation is made according to a expression
    
    Returns:
    See Also:
    getResult()}
  - getCalculatedValue
```
public Num getCalculatedValue()
```
    Return calculated value
    
    Returns:
    See Also:
    hasResult()}
  - setSteps
```
public final void setSteps(java.util.LinkedList<Step> calculationSteps)
```
  - 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

Method Detail

getThis

use

getUsedExtensions

val

val

val

operator

operator

operator

function

expression

expression

expression

openBracket

closeBracket

getProperties

setProperties

setScale

getScale

setRoundingMode

getRoundingMode

setDecimalSeparator

getDecimalSeparator

setGroupingSeparator

getGroupingSeparator

hasStripTrailingZeros

setStripTrailingZeros

setTracingSteps

isTracingSteps

getTracedSteps

calculate

bind

getPostfix

getInfix

setInfix

isCalculated

getCalculatedValue

setSteps

toString