biz.onixs.util

Class ScaledDecimal

java.lang.Object

biz.onixs.util.ScaledDecimal

All Implemented Interfaces:

Serializable, Comparable<ScaledDecimal>

public class ScaledDecimal
extends Object
implements Comparable<ScaledDecimal>, Serializable

Decimal number as an exponent and a mantissa.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LEN String representation max length: sign + mantissa + exponent = 1 + 20 + 63.

Constructor Summary

Constructors

Constructor and Description
ScaledDecimal() Constructor.
ScaledDecimal(BigDecimal bigDecimal) Constructor.
ScaledDecimal(byte[] buffer, int offset, int length) Constructor.
ScaledDecimal(long mantissa, int exponent) Constructor.
ScaledDecimal(String number) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ScaledDecimal o) Compares to the provided object.
boolean	equals(Object obj)
int	getExponent() Method that returns the exponent part of the scaled decimal as an integer
long	getMantissa() Method that returns the mantissa part of the scaled decimal as a long
int	hashCode()
void	normalize() Removes non-significant zeros from the scaled decimal.
void	normalize(int newExponent) Normalize mantissa to the specified exponent.
void	set(BigDecimal bigDecimal) Sets from big decimal representation.
void	set(byte[] buffer, int offset, int length) Sets from byte array.
void	set(String number) Sets from string representation.
void	setExponent(int exponent) Method that sets the value of the exponent part of the scaled decimal.
void	setMantissa(long mantissa) Method that sets the value of the mantissa part of the scaled decimal.
BigDecimal	toBigDecimal() Converts to BigDecimal representation.
int	toByteArray(byte[] buffer, int offset) Converts to byte array.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_LEN

public static final int MAX_LEN

String representation max length: sign + mantissa + exponent = 1 + 20 + 63.

See Also:

Constant Field Values

Constructor Detail

ScaledDecimal

public ScaledDecimal(long mantissa,
                     int exponent)

Constructor.

Parameters:

mantissa - the mantissa representing the number

exponent - the exponent representing the number

Throws:

IllegalArgumentException - if (exponent < -63) or (exponent > 63)

ScaledDecimal

public ScaledDecimal(String number)

Constructor.

Parameters:

number - string representation of a number

Throws:

NumberFormatException - if the string format is incorrect

NullPointerException - if (number == null)

ScaledDecimal

public ScaledDecimal(BigDecimal bigDecimal)

Constructor.

Parameters:

bigDecimal - source value object

Throws:

NullPointerException - if (bigDecimal == null)

ScaledDecimal

public ScaledDecimal(byte[] buffer,
                     int offset,
                     int length)

Constructor.

Parameters:

buffer - source buffer

offset - offset in the source buffer

length - length of the value in the source buffer

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (offset < 0) or (length < 1) or (offset + length > buffer.length)

ScaledDecimal

public ScaledDecimal()

Constructor.

Method Detail

set

public final void set(BigDecimal bigDecimal)

Sets from big decimal representation.

Parameters:

bigDecimal - source value object

Throws:

NullPointerException - if (bigDecimal == null)

set

public final void set(String number)

Sets from string representation.

Parameters:

number - source string

Throws:

NullPointerException - if (number == null)

NumberFormatException - if the string format is incorrect

set

public final void set(byte[] buffer,
                      int offset,
                      int length)

Sets from byte array.

Parameters:

buffer - source buffer

offset - offset in the source buffer

length - length of the value in the source buffer

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (offset < 0) or (length < 1) or (offset + length > buffer.length)

NumberFormatException - if the value parsing fails

getExponent

public final int getExponent()

Method that returns the exponent part of the scaled decimal as an integer

Returns:

the exponent

getMantissa

public final long getMantissa()

Method that returns the mantissa part of the scaled decimal as a long

Returns:

the mantissa

setMantissa

public final void setMantissa(long mantissa)

Method that sets the value of the mantissa part of the scaled decimal.

Parameters:

mantissa - a value of the mantissa part of the scaled decimal

setExponent

public final void setExponent(int exponent)

Method that sets the value of the exponent part of the scaled decimal.

Parameters:

exponent - the exponent

Throws:

IllegalArgumentException - if (exponent < -63) or (exponent > 63)

compareTo

public int compareTo(ScaledDecimal o)

Compares to the provided object.

Specified by:

compareTo in interface Comparable<ScaledDecimal>

Parameters:

o - object to compare to

Returns:

negative, zero or positive if less, equal or more respectively

Throws:

NullPointerException - if (o == null)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBigDecimal

public final BigDecimal toBigDecimal()

Converts to BigDecimal representation.

Returns:

BigDecimal representation

toByteArray

public final int toByteArray(byte[] buffer,
                             int offset)

Converts to byte array.

Please note that produced byte array is based on parsed values but not the source raw number (so in case of overflow they may be different).

Parameters:

buffer - the buffer to use

offset - offset in the buffer to start with

Returns:

bytes used

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (offset < 0) or (offset >= buffer.length)

IndexOutOfBoundsException - if there is no enough space

normalize

public final void normalize()

Removes non-significant zeros from the scaled decimal.

normalize

public final void normalize(int newExponent)

Normalize mantissa to the specified exponent.

Parameters:

newExponent - new exponent.

Throws:

IllegalArgumentException - if converting to new exponent causes data loss in mantissa.

toString

public String toString()

Overrides:

toString in class Object