Numeric (g9 Common 2.9.0 API)

java.lang.Object
- java.lang.Number
- - no.g9.support.Numeric

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Numeric>
```
public class Numeric
extends Number
implements Cloneable, Comparable<Numeric>
```
A wrapper for a BigDecimal value. Ensures that the correct scale is preserved for the BigDecimal value. The default scale for all new instances of Numeric is 0 unless given in the constructor. Instances of this class are not immutable.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Numeric()` Deprecated. (missing javadoc)
`Numeric(BigDecimal d)` Deprecated. (missing javadoc)
`Numeric(BigDecimal d, int scale)` Create a new `Numeric` with given value and scale.
`Numeric(long l)` Deprecated. (missing javadoc)
`Numeric(long l, int scale)` Create a new `Numeric` with given value and scale.
`Numeric(Numeric n)` Deprecated. (missing javadoc)
`Numeric(Numeric n, int scale)` Create a new `Numeric` with given value and scale.
`Numeric(String s)` Deprecated. (missing javadoc)
`Numeric(String s, int scale)` Create a new `Numeric` with given value and scale.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(long l)` Add the given `long` value to this.
`void`	`add(Numeric n)` Add the given `Numeric` value to this.
`byte`	`byteValue()`
`Object`	`clone()` Creates a copy of this object.
`int`	`compareTo(long l)` Compare this to the given `long` value, using `BigDecimal.compareTo()`.
`int`	`compareTo(Numeric ob)` Compare this to the given `Object`, using `BigDecimal.compareTo()`.
`void`	`divide(long l)` Divide this with the given `long` value.
`void`	`divide(Numeric n)` Divide this with the given `Numeric` value.
`double`	`doubleValue()`
`boolean`	`equals(BigDecimal d)` Compare this to the given `BigDecimal` value, using `BigDecimal.equals()`.
`boolean`	`equals(Numeric n)` Compare this to the given `Numeric` value, using `BigDecimal.equals()`.
`boolean`	`equals(Object that)` Compare this to the given `Object`, using `BigDecimal.equals()`.
`float`	`floatValue()`
`int`	`getAsInt100()` Return the `BigDecimal` as an int where its value is multiplied with 100.
`static int`	`getDefaultScale()`
`double`	`getDoubleValue()` Deprecated. (missing javadoc)
`int`	`getIntValue()` Deprecated. (missing javadoc)
`long`	`getLongValue()` Deprecated. (missing javadoc)
`int`	`getScale()` Get scale for this Numeric
`BigDecimal`	`getValue()` Return the `BigDecimal` value.
`int`	`hashCode()`
`int`	`intValue()`
`long`	`longValue()`
`Numeric`	`makeCopy()` Deprecated. (missing javadoc)
`void`	`multiply(long l)` Multiply the given `long` value with this.
`void`	`multiply(Numeric n)` Multiply the given `Numeric` value with this.
`void`	`multiplyPercent(int i)` Multiplies this numeric with the percent given in `n`: <this numeric> * n / 100.
`void`	`negate()` Negate this value
`void`	`round()` Rounds the value with BigDecimal.ROUND_HALF_UP, precision of 0.
`void`	`roundFives()` Rounds the value by five
`void`	`roundTens()` Rounds the value by ten
`static void`	`setDefaultScale(int scale)` Sets the default scale
`void`	`setValue(BigDecimal value)` Set a new `BigDecimal` as the value.
`short`	`shortValue()`
`void`	`subtract(long l)` Subtract the given `long` value from this.
`void`	`subtract(Numeric n)` Subtract the given `Numeric` value from this.
`String`	`toString()`
`String`	`toStringWithoutDecimalPoint()` Return the unscaled value as a `String`.

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

- Constructor Detail
  - Numeric
```
@Deprecated
public Numeric()
```
    Deprecated. (missing javadoc)
    
    Create a new Numeric with zero value and default scale.
  - Numeric
```
@Deprecated
public Numeric(Numeric n)
```
    Deprecated. (missing javadoc)
    
    Create a new Numeric with given value and default scale.
    
    Parameters:
    
    n - The Numeric value to copy.
  - Numeric
```
@Deprecated
public Numeric(long l)
```
    Deprecated. (missing javadoc)
    
    Create a new Numeric with given value and default scale.
    
    Parameters:
    
    l - The long value to set.
  - Numeric
```
@Deprecated
public Numeric(String s)
```
    Deprecated. (missing javadoc)
    
    Create a new Numeric with given value and default scale.
    
    Parameters:
    
    s - A String containing the value to set.
  - Numeric
```
@Deprecated
public Numeric(BigDecimal d)
```
    Deprecated. (missing javadoc)
    
    Create a new Numeric with given value and default scale.
    
    Parameters:
    
    d - A BigDecimal with the value to set.
  - Numeric
```
public Numeric(Numeric n,
               int scale)
```
    Create a new Numeric with given value and scale.
    
    Parameters:
    
    n - The Numeric value to copy.
    
    scale - The scale.
  - Numeric
```
public Numeric(long l,
               int scale)
```
    Create a new Numeric with given value and scale.
    
    Parameters:
    
    l - The long value to set.
    
    scale - The scale.
  - Numeric
```
public Numeric(String s,
               int scale)
```
    Create a new Numeric with given value and scale.
    
    Parameters:
    
    s - A String containing the value to set.
    
    scale - The scale.
  - Numeric
```
public Numeric(BigDecimal d,
               int scale)
```
    Create a new Numeric with given value and scale.
    
    Parameters:
    
    d - A BigDecimal with the value to set.
    
    scale - The scale.
- Method Detail
  - getScale
```
public int getScale()
```
    Get scale for this Numeric
    
    Returns:
    
    the Numeric's scale
  - add
```
public void add(Numeric n)
```
    Add the given Numeric value to this.
    
    Parameters:
    
    n - Numeric operand.
  - add
```
public void add(long l)
```
    Add the given long value to this.
    
    Parameters:
    
    l - long operand.
  - subtract
```
public void subtract(Numeric n)
```
    Subtract the given Numeric value from this.
    
    Parameters:
    
    n - Numeric operand.
  - subtract
```
public void subtract(long l)
```
    Subtract the given long value from this.
    
    Parameters:
    
    l - long operand.
  - multiply
```
public void multiply(Numeric n)
```
    Multiply the given Numeric value with this.
    
    Parameters:
    
    n - Numeric operand.
  - multiply
```
public void multiply(long l)
```
    Multiply the given long value with this.
    
    Parameters:
    
    l - long operand.
  - multiplyPercent
```
public void multiplyPercent(int i)
```
    Multiplies this numeric with the percent given in n: <this numeric> * n / 100. The division part of this calculation is done with precision of 2.
    
    Parameters:
    
    i - Percent.
  - divide
```
public void divide(Numeric n)
```
    Divide this with the given Numeric value.
    
    Parameters:
    
    n - Numeric operand.
  - divide
```
public void divide(long l)
```
    Divide this with the given long value.
    
    Parameters:
    
    l - long operand.
  - round
```
public void round()
```
    Rounds the value with BigDecimal.ROUND_HALF_UP, precision of 0.
  - roundFives
```
public void roundFives()
```
    Rounds the value by five
  - roundTens
```
public void roundTens()
```
    Rounds the value by ten
  - getLongValue
```
@Deprecated
public long getLongValue()
```
    Deprecated. (missing javadoc)
    
    Return the BigDecimal value as an long.
    
    Returns:
    
    value as long.
  - getIntValue
```
@Deprecated
public int getIntValue()
```
    Deprecated. (missing javadoc)
    
    Return the BigDecimal value as a int.
    
    Returns:
    
    value as int.
  - getAsInt100
```
public int getAsInt100()
```
    Return the BigDecimal as an int where its value is multiplied with 100.
    
    Returns:
    
    1.50 is returned as 150.
  - getDoubleValue
```
@Deprecated
public double getDoubleValue()
```
    Deprecated. (missing javadoc)
    
    Return the BigDecimal value as a double.
    
    Returns:
    
    value as double.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringWithoutDecimalPoint
```
public String toStringWithoutDecimalPoint()
```
    Return the unscaled value as a String.
    
    Returns:
    
    unscaled value as String.
  - makeCopy
```
@Deprecated
public Numeric makeCopy()
```
    Deprecated. (missing javadoc)
    
    Return a copy of this numeric, with the same scale.
    
    Returns:
    
    The copied Numeric.
  - setValue
```
public void setValue(BigDecimal value)
```
    Set a new BigDecimal as the value. The previous scale is preserved.
    
    Parameters:
    
    value - The new value.
  - getValue
```
public BigDecimal getValue()
```
    Return the BigDecimal value.
    
    Returns:
    
    value.
  - compareTo
```
public int compareTo(long l)
```
    Compare this to the given long value, using BigDecimal.compareTo().
    
    Parameters:
    
    l - value to compare.
    
    Returns:
    
    result of comparison.
  - compareTo
```
public int compareTo(Numeric ob)
```
    Compare this to the given Object, using BigDecimal.compareTo().
    
    Specified by:
    
    compareTo in interface Comparable<Numeric>
    
    Parameters:
    
    ob - object to compare.
    
    Returns:
    
    result of comparison, 0 if ob is not a Numeric.
  - equals
```
public boolean equals(Numeric n)
```
    Compare this to the given Numeric value, using BigDecimal.equals().
    
    Parameters:
    
    n - value to compare.
    
    Returns:
    
    result of comparison.
  - equals
```
public boolean equals(BigDecimal d)
```
    Compare this to the given BigDecimal value, using BigDecimal.equals().
    
    Parameters:
    
    d - value to compare.
    
    Returns:
    
    result of comparison.
  - equals
```
public boolean equals(Object that)
```
    Compare this to the given Object, using BigDecimal.equals().
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    that - object to compare.
    
    Returns:
    
    result of comparison, false if ob is not a Numeric.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDefaultScale
```
public static int getDefaultScale()
```
    Returns:
    
    the defaultScale property.
  - setDefaultScale
```
public static void setDefaultScale(int scale)
```
    Sets the default scale
    
    Parameters:
    
    scale - the new default scale
  - negate
```
public void negate()
```
    Negate this value
  - byteValue
```
public byte byteValue()
```
    Overrides:
    
    byteValue in class Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class Number
  - shortValue
```
public short shortValue()
```
    Overrides:
    
    shortValue in class Number
  - clone
```
public Object clone()
```
    Creates a copy of this object. Overrides Object.clone.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A clone of this Object.
    
    See Also:
    
    Object.clone()

Class Numeric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Numeric

Numeric

Numeric

Numeric

Numeric

Numeric

Numeric

Numeric

Numeric

Method Detail

getScale

add

add

subtract

subtract

multiply

multiply

multiplyPercent

divide

divide

round

roundFives

roundTens

getLongValue

getIntValue

getAsInt100

getDoubleValue

toString

toStringWithoutDecimalPoint

makeCopy

setValue

getValue

compareTo

compareTo

equals

equals

equals

hashCode

getDefaultScale

setDefaultScale

negate

byteValue

doubleValue

floatValue

intValue

longValue

shortValue

clone