Decimal

java.lang.Object
- eve.data.DataObject
- - eve.math.Decimal

All Implemented Interfaces:

DataUnit, Value, ByteDecodable, ByteEncodable, Copyable, LocaleFormatted, Stringable, Comparable

Direct Known Subclasses:

Currency
```
public class Decimal
extends DataObject
implements Value, ByteEncodable, ByteDecodable, LocaleFormatted
```
A Decimal is a mutable version of BigDecimal. It contains a BigDecimal within itself which you can access and replace with a new value if needed.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`defaultFormatNoThousandGrouping` This is the default value for the ThousandGrouping on newly created Decimal values - it is false by default.
`protected boolean`	`isCurrency` Set this true to indicate that this Decimal value is a currency value.
`int`	`localeFormatOptionsToClear` These are LocaleFormat option bits to clear, overriding the default options for the locale.
`int`	`localeFormatOptionsToSet` These are LocaleFormat option bits to set, overriding the default options for the locale.
`String`	`outputFormat`

Constructor Summary

Constructors
Constructor and Description

Decimal()

Decimal(BigDecimal bd)

Decimal(BigDecimal jbd)

Decimal(double value)

Decimal(String str)

Constructors
Constructor and Description
`Decimal()`
`Decimal(BigDecimal bd)`
`Decimal(BigDecimal jbd)`
`Decimal(double value)`
`Decimal(String str)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object other)` Compare this object with another.
`void`	`copyFrom(Object other)` Copy all appropriate data from another object.
`int`	`decodeBytes(byte[] source, int offset, int length)` This requests the Object to decode itself from a stream of bytes.
`byte[]`	`encodeBytes()`
`int`	`encodeBytes(ByteArray dest)` This requests the Object to encode itself as a stream of bytes which is appended to the destination ByteArray.
`void`	`format(LocaleFormat locale, CharArray dest)`
`void`	`fromString(char[] src, int offset, int length)`
`void`	`fromString(String value)`
`BigDecimal`	`getBigDecimal()`
`Object`	`getCopy()` Return a copy of this object.
`BigDecimal`	`getJavaBigDecimal()`
`boolean`	`isCurrency()` Returns if this Decimal value is considered a currency value.
`void`	`parse(LocaleFormat locale, char[] data, int offset, int length)`
`void`	`setBigDecimal(BigDecimal bd)`
`Decimal`	`setDouble(double value)`
`void`	`setJavaBigDecimal(BigDecimal jbd)`
`String`	`toString()` Return a String representation of this object.
`CharArray`	`toString(CharArray dest)`

Methods inherited from class eve.data.DataObject
_getFieldType, _getSetField, cache, copied, equals, getDeclaredField, getDeclaredFieldValue, getMyFieldList, getNew

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

- Field Detail
  - isCurrency
```
protected boolean isCurrency
```
    Set this true to indicate that this Decimal value is a currency value.
  - outputFormat
```
public String outputFormat
```
  - defaultFormatNoThousandGrouping
```
public static boolean defaultFormatNoThousandGrouping
```
    This is the default value for the ThousandGrouping on newly created Decimal values - it is false by default.
  - localeFormatOptionsToSet
```
public int localeFormatOptionsToSet
```
    These are LocaleFormat option bits to set, overriding the default options for the locale.
  - localeFormatOptionsToClear
```
public int localeFormatOptionsToClear
```
    These are LocaleFormat option bits to clear, overriding the default options for the locale.
- Constructor Detail
  - Decimal
```
public Decimal()
```
  - Decimal
```
public Decimal(double value)
```
  - Decimal
```
public Decimal(BigDecimal bd)
```
  - Decimal
```
public Decimal(BigDecimal jbd)
```
  - Decimal
```
public Decimal(String str)
```
- Method Detail
  - isCurrency
```
public boolean isCurrency()
```
    Returns if this Decimal value is considered a currency value.
  - getCopy
```
public Object getCopy()
```
    Description copied from interface: Copyable
    
    Return a copy of this object.
    
    Specified by:
    
    getCopy in interface Copyable
    
    Overrides:
    
    getCopy in class DataObject
  - copyFrom
```
public void copyFrom(Object other)
```
    Description copied from interface: DataUnit
    
    Copy all appropriate data from another object.
    
    Specified by:
    
    copyFrom in interface DataUnit
    
    Overrides:
    
    copyFrom in class DataObject
  - compareTo
```
public int compareTo(Object other)
```
    Description copied from interface: Comparable
    
    Compare this object with another. It should return: less than 0 if this object is considered LESS than the "other" object; greater than 0 if this object is considered GREATER than the "other" object; 0 if this object is considered EQUAL to the "other" object. (i.e. it is an implicit subtraction).
    
    Specified by:
    
    compareTo in interface Comparable
    
    Overrides:
    
    compareTo in class DataObject
  - toString
```
public String toString()
```
    Description copied from class: Object
    
    Return a String representation of this object.
    
    Specified by:
    
    toString in interface Stringable
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representing this object.
  - fromString
```
public void fromString(String value)
```
    Specified by:
    
    fromString in interface Stringable
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
  - getJavaBigDecimal
```
public BigDecimal getJavaBigDecimal()
```
  - setBigDecimal
```
public void setBigDecimal(BigDecimal bd)
```
  - setJavaBigDecimal
```
public void setJavaBigDecimal(BigDecimal jbd)
```
  - encodeBytes
```
public int encodeBytes(ByteArray dest)
```
    Description copied from interface: ByteEncodable
    
    This requests the Object to encode itself as a stream of bytes which is appended to the destination ByteArray. If the destination ByteArray is null, then the object should report how many bytes would be used if the object was encoded.
    
    Specified by:
    
    encodeBytes in interface ByteEncodable
    
    Parameters:
    
    dest - The destination ByteArray, or null to determine the number of bytes needed to encode.
    
    Returns:
    
    The number of bytes appended to the ByteArray or the number of bytes needed to encode.
  - encodeBytes
```
public byte[] encodeBytes()
```
    Specified by:
    
    encodeBytes in interface ByteEncodable
  - decodeBytes
```
public int decodeBytes(byte[] source,
                       int offset,
                       int length)
```
    Description copied from interface: ByteDecodable
    
    This requests the Object to decode itself from a stream of bytes.
    
    Specified by:
    
    decodeBytes in interface ByteDecodable
    
    Parameters:
    
    source - The source of the encoded bytes.
    
    offset - Where the object should start decoding from.
    
    length - The number of bytes left starting from startOffsetInSource.
    
    Returns:
    
    the number of bytes decoded.
  - setDouble
```
public Decimal setDouble(double value)
```
  - toString
```
public CharArray toString(CharArray dest)
```
    Specified by:
    
    toString in interface Stringable
  - fromString
```
public void fromString(char[] src,
                       int offset,
                       int length)
```
    Specified by:
    
    fromString in interface Stringable
  - format
```
public void format(LocaleFormat locale,
                   CharArray dest)
```
    Specified by:
    
    format in interface LocaleFormatted
  - parse
```
public void parse(LocaleFormat locale,
                  char[] data,
                  int offset,
                  int length)
           throws ParseException
```
    Specified by:
    
    parse in interface LocaleFormatted
    
    Throws:
    
    ParseException

Class Decimal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class eve.data.DataObject

Methods inherited from class java.lang.Object

Field Detail

isCurrency

outputFormat

defaultFormatNoThousandGrouping

localeFormatOptionsToSet

localeFormatOptionsToClear

Constructor Detail

Decimal

Decimal

Decimal

Decimal

Decimal

Method Detail

isCurrency

getCopy

copyFrom

compareTo

toString

fromString

getBigDecimal

getJavaBigDecimal

setBigDecimal

setJavaBigDecimal

encodeBytes

encodeBytes

decodeBytes

setDouble

toString

fromString

format

parse