org.jcoderz.commons.types.samples
Class SampleFixPoint

java.lang.Object
  java.lang.Number
      org.jcoderz.commons.types.samples.SampleFixPoint

All Implemented Interfaces:

Serializable, Comparable, FixPointNumber, StrongType

public final class SampleFixPoint
extends Number
implements Comparable, FixPointNumber, Serializable

Fix point numeric to represent SampleFixPoint.

Permitted values range from -100.50 to 999.99. It the number of decimal digits supported is 2 and the total number of digits is 5

Instances of this class are immutable.

Author:

generated

See Also:

Serialized Form

Field Summary

static SampleFixPoint	CONSTANT_VALUE Additional Constant defined in the XML document.
static long	DECIMAL_SCALE The scale (100).
static int	FRACTION_DIGITS The number of fraction digits (2).
static Integer	FRACTION_DIGITS_AS_INTEGER The number of fraction digits as integer (2).
static SampleFixPoint	MAX_VALUE The maximal value of SampleFixPoint (999.99).
static long	MAX_VALUE_SCALED The maximal scaled value of SampleFixPoint (999L).
static long	MAX_VALUE_UNSCALED The maximal value of SampleFixPoint (99999L).
static SampleFixPoint	MIN_VALUE The minimal value of SampleFixPoint (-100.50).
static long	MIN_VALUE_SCALED The minimal scaled value of SampleFixPoint (-100L).
static long	MIN_VALUE_UNSCALED The minimal unscaled value of SampleFixPoint (-10050L).
static String	PREFERED_DATABASE_TYPE The preffered database representation of this type.
static int	SCALE The number of fraction digits (2).
static int	TOTAL_DIGITS The maximum number of digits (5).
static Integer	TOTAL_DIGITS_AS_INTEGER The maximum number of digits as Integer (5).
static String	TYPE_NAME SampleFixPoint - the name of this type as String constant.
static SampleFixPoint	ZERO The ZERO instance.

Method Summary

int	compareTo(Object o)
double	doubleValue()
boolean	equals(Object obj)
float	floatValue()
static SampleFixPoint	fromString(String str) Creates a SampleFixPoint object from the String representation.
int	hashCode()
int	intValue()
long	longValue()
BigDecimal	toBigDecimal() Returns the BigDecimal representation of this SampleFixPoint.
String	toString() Returns the String representation of this SampleFixPoint.
long	unscaledLongValue() Returns the unscaled long value of this SampleFixPoint.
static SampleFixPoint	valueOf(BigDecimal bd) Translates a BigDecimal value into a SampleFixPoint.
static SampleFixPoint	valueOf(long val) Translates a long value into a SampleFixPoint.
static SampleFixPoint	valueOf(long unscaledVal, int scale) Translates a long with the given scale into a SampleFixPoint.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final String TYPE_NAME

SampleFixPoint - the name of this type as String constant.

See Also:

Constant Field Values

PREFERED_DATABASE_TYPE

public static final String PREFERED_DATABASE_TYPE

The preffered database representation of this type.

See Also:

Constant Field Values

MIN_VALUE_UNSCALED

public static final long MIN_VALUE_UNSCALED

The minimal unscaled value of SampleFixPoint (-10050L).

See Also:

Constant Field Values

MAX_VALUE_UNSCALED

public static final long MAX_VALUE_UNSCALED

The maximal value of SampleFixPoint (99999L).

See Also:

Constant Field Values

FRACTION_DIGITS

public static final int FRACTION_DIGITS

The number of fraction digits (2).

See Also:

Constant Field Values

SCALE

public static final int SCALE

The number of fraction digits (2).

See Also:

Constant Field Values

DECIMAL_SCALE

public static final long DECIMAL_SCALE

The scale (100).

See Also:

Constant Field Values

MIN_VALUE_SCALED

public static final long MIN_VALUE_SCALED

The minimal scaled value of SampleFixPoint (-100L).

See Also:

Constant Field Values

MAX_VALUE_SCALED

public static final long MAX_VALUE_SCALED

The maximal scaled value of SampleFixPoint (999L).

See Also:

Constant Field Values

FRACTION_DIGITS_AS_INTEGER

public static final Integer FRACTION_DIGITS_AS_INTEGER

The number of fraction digits as integer (2).

TOTAL_DIGITS

public static final int TOTAL_DIGITS

The maximum number of digits (5).

See Also:

Constant Field Values

TOTAL_DIGITS_AS_INTEGER

public static final Integer TOTAL_DIGITS_AS_INTEGER

The maximum number of digits as Integer (5).

MIN_VALUE

public static final SampleFixPoint MIN_VALUE

The minimal value of SampleFixPoint (-100.50).

MAX_VALUE

public static final SampleFixPoint MAX_VALUE

The maximal value of SampleFixPoint (999.99).

ZERO

public static final SampleFixPoint ZERO

The ZERO instance.

CONSTANT_VALUE

public static final SampleFixPoint CONSTANT_VALUE

Additional Constant defined in the XML document.

Method Detail

fromString

public static SampleFixPoint fromString(String str)
                                 throws ArgumentMalformedException

Creates a SampleFixPoint object from the String representation.

Parameters:

str - The str representation of the SampleFixPoint to be returned.

Returns:

The SampleFixPoint object represented by this str.

Throws:

ArgumentMalformedException - If the given String violates the restriction of the SampleFixPoint type.

valueOf

public static SampleFixPoint valueOf(BigDecimal bd)

Translates a BigDecimal value into a SampleFixPoint.

Parameters:

bd - the BigDecimal.

Returns:

a SampleFixPoint whose value is equal to bd.

Throws:

ArgumentMalformedException - If the given BigDecimal violates the restriction of the SampleFixPoint type.

valueOf

public static SampleFixPoint valueOf(long val)

Translates a long value into a SampleFixPoint.

Parameters:

val - the long.

Returns:

a SampleFixPoint whose value is equal to the given long.

Throws:

ArgumentMalformedException - If the given long violates the restriction of the SampleFixPoint type.

See Also:

BigDecimal.valueOf(long)

valueOf

public static SampleFixPoint valueOf(long unscaledVal,
                                     int scale)

Translates a long with the given scale into a SampleFixPoint.

Parameters:

unscaledVal - the unscaled value.

scale - the scale to be applied.

Returns:

a SampleFixPoint whose value is (unscaledVal × 10^-scale).

Throws:

ArgumentMalformedException - If the given long and scale violates the restriction of the SampleFixPoint type.

See Also:

BigDecimal.valueOf(long, int)

unscaledLongValue

public long unscaledLongValue()

Returns the unscaled long value of this SampleFixPoint. The actual value is the returned value / DECIMAL_SCALE.

Specified by:

unscaledLongValue in interface FixPointNumber

Returns:

The unscaled long value of this SampleFixPoint.

toString

public String toString()

Returns the String representation of this SampleFixPoint. The implementation does not apply any localization rules.

Overrides:

toString in class Object

Returns:

The String representation of this SampleFixPoint.

See Also:

BigDecimal.toString()

toBigDecimal

public BigDecimal toBigDecimal()

Returns the BigDecimal representation of this SampleFixPoint.

Specified by:

toBigDecimal in interface FixPointNumber

Returns:

The BigDecimal representation of this SampleFixPoint.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable