org.jdice.calc

Class Num

java.lang.Object

org.jdice.calc.Num

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Num>

public class Num
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<Num>, java.io.Serializable

Mutable wrapper object around BigDecimal object. Supported input type: short, int, long, float, double, Short, Integer, Long, Float, Double, BigInteger, BigDecimal, String
AbstractCalculator, Num To support custom type objects, you can use NumConverter to implement conversion logic from specific type to Num.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Num() Create Num instance with zero default value
Num(java.lang.Object value) Create Num instance with value of given Object
Num(java.lang.Object value, java.lang.Class<? extends NumConverter> converter) Create Num instance with value of given Object
Num(java.lang.String value) Create Num instance with value from String
Num(java.lang.String value, char decimalSeparator) Create Num instance with value from String which use defined decimal separator
Num(java.lang.String name, java.lang.Object value) Create Num instance with specific name and value of given Object
Num(java.lang.String name, java.lang.Object value, java.lang.Class<? extends NumConverter> converter) Create Num instance with specific name and value of given Object
Num(java.lang.String name, java.lang.String value, char decimalSeparator) Create Num instance with specific name and value from String which use defined decimal separator

Method Summary

Methods

Modifier and Type	Method and Description
Num	abs() Return new instance of Num with absolute value
byte	byteValue()
byte	byteValueExact()
Num	ceil() Return new instance of Num with ceil value.
Num	clone()
int	compareTo(Num value2) Compares this Num with the specified Num.
double	doubleValue()
boolean	equals(java.math.BigDecimal obj)
boolean	equals(Num obj)
boolean	equals(java.lang.Object object) Compares this Decimal (internally BigDecimal) with the specified Object for equality.
float	floatValue()
Num	floor() Return new instance of Num with floor value e.g.
java.math.BigDecimal	get() Get BigDecimal without trailing zeros if hasStripTrailingZeros() is TRUE And set scale defined by properties
java.math.BigDecimal	get(int scale) Get BigDecimal in defined scale, rounding mode and strip trailing zeros from properties
java.math.BigDecimal	get(int scale, Rounding roundingMode) Return BigDecimal in defined scale with specified rounding mode
java.lang.String	getFormated() Get formated representation of number defined by setOutputFormat(String)
java.math.BigDecimal	getFraction()
int	getFractionSize()
java.lang.String	getName() Get name of this variable.
java.lang.Object	getOriginalValue()
Properties	getProperties()
Rounding	getRoundingMode() Gets the rounding mode for division operations The default is RoundingMode.HALF_UP
java.lang.Integer	getScale() Sets the scale for division operations.
boolean	hasFraction()
int	hashCode() Returns the hash code for this Decimal.
boolean	hasStripTrailingZeros()
int	intValue()
int	intValueExact()
boolean	isEqual(Num value) Compare if two number are equal regardless scale
boolean	isEqual(java.lang.Object value) Convert value to Num then compare values regardles scale
boolean	isEqual(java.lang.Object value, boolean autoscale) Scale both value to scale of number which have minimum scale.
boolean	isEqual(java.lang.Object value, java.lang.Class<? extends NumConverter> converter)
boolean	isEqual(java.lang.Object value, int scale) Convert value to Num, and scale both value before comparing them.
boolean	isEqual(java.lang.Object value, int scale, Rounding rounding) Convert value to Num, and scale both value before comparing them.
boolean	isEqual(java.lang.String value) Compare if two number are equal regardless scale
boolean	isEqual(java.lang.String value, char decimalSeparator) Compare if two number are equal regardless scale
boolean	isNegative()
boolean	isZero()
long	longValue()
long	longValueExact()
Num	set(java.lang.Object value)
Num	set(java.lang.Object value, java.lang.Class<? extends NumConverter> converter)
Num	set(java.lang.String value)
Num	set(java.lang.String value, char decimalSeparator)
Num	setName(java.lang.String name)
Num	setOutputFormat(java.lang.String format) Set output format for number.
Num	setProperties(Properties properties)
Num	setRoundingMode(Rounding roundingMode) Sets the rounding mode for decimal divisions.
Num	setScale(int scale) Sets the scale for division operations.
Num	setScale(int scale, Rounding roundingMode) Sets the scale and rounding mode for division operations.
Num	setStripTrailingZeros(boolean stripTrailingZeros)
short	shortValue()
short	shortValueExact()
int	signum()
static java.lang.String	stripNumber(java.lang.String value, char decimalSeparator) Remove from string number representation all character except numbers and decimal point.
java.math.BigDecimal	toBigDecimal() Return BigDecimal, same as get()
java.math.BigDecimal	toBigDecimal(java.lang.Integer scale, Rounding rounding, boolean stripTrailingZeros) Return BigDecimal
java.lang.String	toEngineeringString()
static Num	toNum(java.lang.Object object)
static Num	toNum(java.lang.Object object, java.lang.Class<? extends NumConverter> converter)
static Num[]	toNums(java.lang.Object... object)
<T> T	toObject(java.lang.Class<T> toClass) Convert Num to defined custom object
<T> T	toObject(java.lang.Class<T> toClass, java.lang.Class<? extends NumConverter> converterClass) Convert Num to defined custom object
<T> T	toObject(java.lang.Class<T> toClass, NumConverter numConverter) Convert Num to defined custom object
java.lang.String	toString()
java.lang.String	toString(char decimalSeparator)
java.lang.String	toString(java.lang.Character groupingSeparator, char decimalSeparator)
java.lang.String	toString(java.lang.Character groupingSeparator, char decimalSeparator, java.lang.String format)
java.lang.String	toString(java.lang.String format) Use properties (getProperties()) grouping separator and decimal separator and specified format by rules of DecimalFormat DecimalFormat e.g.
java.lang.String	toStringWithDetail()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Num

public Num()

Create Num instance with zero default value

Num

public Num(java.lang.Object value)

Create Num instance with value of given Object

Parameters:

value - that can be short, int, long, float, double, Short, Integer, Long, Float, Double, BigInteger, BigDecimal, String or custom object which need conversion with NumConverter

Num

public Num(java.lang.String name,
   java.lang.Object value)

Create Num instance with specific name and value of given Object

Parameters:

name - used in expression with unknown value

value - that can be short, int, long, float, double, Short, Integer, Long, Float, Double, BigInteger, BigDecimal, String or custom object which need conversion with NumConverter

Num

public Num(java.lang.Object value,
   java.lang.Class<? extends NumConverter> converter)

Create Num instance with value of given Object

Parameters:

value - that can be short, int, long, float, double, Short, Integer, Long, Float, Double, BigInteger, BigDecimal, String or custom object which need conversion with NumConverter

converter - class used for converting custom object.

See Also:

NumConverter

Num

public Num(java.lang.String name,
   java.lang.Object value,
   java.lang.Class<? extends NumConverter> converter)

Create Num instance with specific name and value of given Object

Parameters:

name - used in expression with unknown value

value - that can be short, int, long, float, double, Short, Integer, Long, Float, Double, BigInteger, BigDecimal, String or custom object which need conversion with NumConverter

converter - class used for converting custom object.

See Also:

NumConverter

Num

public Num(java.lang.String value)

Create Num instance with value from String

Parameters:

value -

Num

public Num(java.lang.String value,
   char decimalSeparator)

Create Num instance with value from String which use defined decimal separator

Parameters:

value -

decimalSeparator - used in String value

Num

public Num(java.lang.String name,
   java.lang.String value,
   char decimalSeparator)

Create Num instance with specific name and value from String which use defined decimal separator

Parameters:

name - used in expression with unknown value

value -

decimalSeparator - used in String value

Method Detail

set

public Num set(java.lang.Object value)

set

public Num set(java.lang.Object value,
      java.lang.Class<? extends NumConverter> converter)

set

public Num set(java.lang.String value)

set

public Num set(java.lang.String value,
      char decimalSeparator)

setName

public Num setName(java.lang.String name)

getName

public java.lang.String getName()

Get name of this variable. Used for expression with unknown variables e.g. 5 + X

Returns:

getProperties

public Properties getProperties()

setProperties

public Num setProperties(Properties properties)

setScale

public Num setScale(int scale)

Sets the scale for division operations.

Parameters:

scale - scale for division operations

Returns:

setScale

public Num setScale(int scale,
           Rounding roundingMode)

Sets the scale and rounding mode for division operations.

Parameters:

scale - scale for division operations

roundingMode - rounding mode for division operations

Returns:

getScale

public java.lang.Integer getScale()

Sets the scale for division operations. The default is 64

Returns:

setRoundingMode

public Num setRoundingMode(Rounding roundingMode)

Sets the rounding mode for decimal divisions.

Parameters:

roundingMode - rounding mode for decimal divisions

Returns:

getRoundingMode

public Rounding getRoundingMode()

Gets the rounding mode for division operations The default is RoundingMode.HALF_UP

Returns:

hasStripTrailingZeros

public boolean hasStripTrailingZeros()

setStripTrailingZeros

public Num setStripTrailingZeros(boolean stripTrailingZeros)

setOutputFormat

public Num setOutputFormat(java.lang.String format)

Set output format for number.

Parameters:

format - - DecimalFormat e.g. #,###,###,##0.00

Returns:

toBigDecimal

public java.math.BigDecimal toBigDecimal()

Return BigDecimal, same as get()

Returns:

See Also:

get()

toBigDecimal

public java.math.BigDecimal toBigDecimal(java.lang.Integer scale,
                                Rounding rounding,
                                boolean stripTrailingZeros)

Return BigDecimal

Returns:

See Also:

get()

get

public java.math.BigDecimal get()

Get BigDecimal without trailing zeros if hasStripTrailingZeros() is TRUE And set scale defined by properties

Returns:

See Also:

toBigDecimal(), toBigDecimal(Integer, Rounding, boolean)

get

public java.math.BigDecimal get(int scale)

Get BigDecimal in defined scale, rounding mode and strip trailing zeros from properties

Parameters:

scale -

Returns:

get

public java.math.BigDecimal get(int scale,
                       Rounding roundingMode)

Return BigDecimal in defined scale with specified rounding mode

Parameters:

scale -

roundingMode -

Returns:

getFraction

public java.math.BigDecimal getFraction()

getFractionSize

public int getFractionSize()

hasFraction

public boolean hasFraction()

isZero

public boolean isZero()

isNegative

public boolean isNegative()

toObject

public <T> T toObject(java.lang.Class<T> toClass)

Convert Num to defined custom object

Parameters:

customObject -

Returns:

toObject

public <T> T toObject(java.lang.Class<T> toClass,
             java.lang.Class<? extends NumConverter> converterClass)

Convert Num to defined custom object

Parameters:

customObject -

Returns:

toObject

public <T> T toObject(java.lang.Class<T> toClass,
             NumConverter numConverter)

Convert Num to defined custom object

Parameters:

customObject -

Returns:

toStringWithDetail

public java.lang.String toStringWithDetail()

getFormated

public java.lang.String getFormated()

Get formated representation of number defined by setOutputFormat(String)

Parameters:

format - - DecimalFormat e.g. #,###,###,##0.00

Returns:

String

See Also:

toString(Character groupingSeparator, char decimalSeparator), toString(Character, char)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String format)

Use properties (getProperties()) grouping separator and decimal separator and specified format by rules of DecimalFormat DecimalFormat e.g. #,###,###,##0.00

Parameters:

format -

Returns:

toString

public java.lang.String toString(char decimalSeparator)

toString

public java.lang.String toString(java.lang.Character groupingSeparator,
                        char decimalSeparator)

toString

public java.lang.String toString(java.lang.Character groupingSeparator,
                        char decimalSeparator,
                        java.lang.String format)

getOriginalValue

public java.lang.Object getOriginalValue()

clone

public Num clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Returns the hash code for this Decimal. Note that two Decimal objects that are numerically equal but differ in scale (like 2.0 and 2.00) will generally have the same hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code for this Decimal.

See Also:

equals(Object)

isEqual

public boolean isEqual(java.lang.String value)

Compare if two number are equal regardless scale

Parameters:

value -

Returns:

See Also:

compareTo(Num)

isEqual

public boolean isEqual(java.lang.String value,
              char decimalSeparator)

Compare if two number are equal regardless scale

Parameters:

value -

Returns:

See Also:

compareTo(Num)

isEqual

public boolean isEqual(Num value)

Compare if two number are equal regardless scale

 e.g. 1254.5800 sameAs(1254.58)  = true 
      1254.58   sameAs(1254.580) = true 
      1254.5848 sameAs(1254.58)  = false
     
 

Parameters:

value -

Returns:

See Also:

compareTo(Num)

isEqual

public boolean isEqual(java.lang.Object value)

Convert value to Num then compare values regardles scale

Parameters:

value -

Returns:

isEqual

public boolean isEqual(java.lang.Object value,
              int scale)

Convert value to Num, and scale both value before comparing them.

Parameters:

value -

Returns:

isEqual

public boolean isEqual(java.lang.Object value,
              boolean autoscale)

Scale both value to scale of number which have minimum scale.

Parameters:

value -

autoscale -

Returns:

isEqual

public boolean isEqual(java.lang.Object value,
              int scale,
              Rounding rounding)

Convert value to Num, and scale both value before comparing them.

Parameters:

value -

Returns:

isEqual

public boolean isEqual(java.lang.Object value,
              java.lang.Class<? extends NumConverter> converter)

equals

public boolean equals(java.lang.Object object)

Compares this Decimal (internally BigDecimal) with the specified Object for equality. Unlike compareTo, this method considers two Decimal objects equal only if they are equal in value and scale (thus 2.0 is not equal to 2.00 when compared by this method).

Overrides:

equals in class java.lang.Object

Parameters:

object - Object to which this Decimal is to be compared.

Returns:

true if and only if the specified Object is a Decimal whose value and scale are equal to this Decimal's.

See Also:

#compareTo(java.math.Num), hashCode(), #sameAs

equals

public boolean equals(Num obj)

equals

public boolean equals(java.math.BigDecimal obj)

compareTo

public int compareTo(Num value2)

Compares this Num with the specified Num. Two Decimal objects that are equal in value but have a different scale (like 2.0 and 2.00) are considered equal by this method. This method is provided in preference to individual methods for each of the six boolean comparison operators (<, ==, >, >=, !=, <=). The suggested idiom for performing these comparisons is: (x.compareTo(y) <op> 0), where <op> is one of the six comparison operators.

Specified by:

compareTo in interface java.lang.Comparable<Num>

Parameters:

val - Decimal to which this Decimal is to be compared.

Returns:

-1, 0, or 1 as this Num is numerically less than, equal to, or greater than Num.

See Also:

#even

byteValue

public byte byteValue()

byteValueExact

public byte byteValueExact()

doubleValue

public double doubleValue()

floatValue

public float floatValue()

intValue

public int intValue()

intValueExact

public int intValueExact()

longValue

public long longValue()

longValueExact

public long longValueExact()

shortValue

public short shortValue()

shortValueExact

public short shortValueExact()

signum

public int signum()

toEngineeringString

public java.lang.String toEngineeringString()

abs

public Num abs()

Return new instance of Num with absolute value

Returns:

ceil

public Num ceil()

Return new instance of Num with ceil value. e.g. for 3.5 -> 4.0

Returns:

floor

public Num floor()

Return new instance of Num with floor value e.g. for 3.5 -> 3.0

Returns:

stripNumber

public static java.lang.String stripNumber(java.lang.String value,
                           char decimalSeparator)

Remove from string number representation all character except numbers and decimal point.
And replace given decimalSeparator with '.'

 ("44,551.06", '.')        => 44551.06
 ("1 255 844,551.06", '.') => 1255844551.06
 ("44,551..06", '.')       => 44551.06
 

Parameters:

decimalSeparator -

value -

toNum

public static Num toNum(java.lang.Object object)

toNum

public static Num toNum(java.lang.Object object,
        java.lang.Class<? extends NumConverter> converter)

toNums

public static Num[] toNums(java.lang.Object... object)