MFDecimal (3.13.0 510 API)

java.lang.Object
- com.marketfactory.api.MFDecimal

All Implemented Interfaces:

java.lang.Comparable
```
public class MFDecimal
extends java.lang.Object
implements java.lang.Comparable
```
A thin immutable wrapper for a floating point number. Must be 15 digits or less.

Field Summary

Fields
Modifier and Type	Field and Description
`static MFDecimal`	`NA` Special value: Not Applicable.
`static MFDecimal`	`NDA` Special value: No Data Available.
`static MFDecimal`	`NMA` Special value: No Market Available.
`static MFDecimal`	`ZERO` Special value: Zero (as a convenience).

Constructor Summary

Constructors
Constructor and Description

MFDecimal(java.lang.String s)
Constructor which accepts a string value.

Constructors
Constructor and Description
`MFDecimal(java.lang.String s)` Constructor which accepts a string value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MFDecimal`	`abs()` Absolute value.
`int`	`compareTo(java.lang.Object o)` Implements Comparable method compareTo.
`boolean`	`equals(MFDecimal o)` Comparison operator: equal.
`boolean`	`gt(MFDecimal o)` Comparison operator: greater-than.
`boolean`	`gte(MFDecimal o)` Comparison operator: greater-than or equal.
`int`	`hashCode()` Forwards to raw value.
`static boolean`	`isValid(MFDecimal o)` Check if MFDecimal object has valid value.
`boolean`	`lt(MFDecimal o)` Comparison operator: less-than.
`boolean`	`lte(MFDecimal o)` Comparison operator: less-than or equal.
`MFDecimal`	`neg()` Negate value.
`double`	`toDouble()` Convert the value.
`long`	`toLong()` Convert the value.
`java.lang.String`	`toString()` Provide access to the raw value.
`static MFDecimal`	`valueOf(java.math.BigDecimal num)` Returns a MFDecimal object for the given representation of a FP number.
`static MFDecimal`	`valueOf(double num)` Returns a MFDecimal object for the given representation of a FP number.
`static MFDecimal`	`valueOf(long num)` Returns a MFDecimal object for the given representation of a FP number.
`static MFDecimal`	`valueOf(java.lang.String s)` Returns a MFDecimal object for the given representation of a FP number.

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

- Field Detail
  - NMA
```
public static MFDecimal NMA
```
    Special value: No Market Available.
  - NDA
```
public static MFDecimal NDA
```
    Special value: No Data Available.
  - NA
```
public static MFDecimal NA
```
    Special value: Not Applicable.
  - ZERO
```
public static MFDecimal ZERO
```
    Special value: Zero (as a convenience).
- Constructor Detail
  - MFDecimal
```
public MFDecimal(java.lang.String s)
          throws java.lang.NumberFormatException
```
    Constructor which accepts a string value.
    
    Throws:
    
    java.lang.NumberFormatException
- Method Detail
  - valueOf
```
public static MFDecimal valueOf(java.lang.String s)
                         throws java.lang.NumberFormatException
```
    Returns a MFDecimal object for the given representation of a FP number.
    
    Throws:
    
    java.lang.NumberFormatException
  - valueOf
```
public static MFDecimal valueOf(java.math.BigDecimal num)
                         throws java.lang.NumberFormatException
```
    Returns a MFDecimal object for the given representation of a FP number.
    
    Throws:
    
    java.lang.NumberFormatException
  - valueOf
```
public static MFDecimal valueOf(double num)
```
    Returns a MFDecimal object for the given representation of a FP number.
  - valueOf
```
public static MFDecimal valueOf(long num)
```
    Returns a MFDecimal object for the given representation of a FP number.
  - toLong
```
public long toLong()
```
    Convert the value. Will throw UnsupportedOperationException if not valid. Will throw NumberFormatException if value is out of range.
  - toDouble
```
public double toDouble()
```
    Convert the value. Will throw UnsupportedOperationException if not valid.
  - toString
```
public java.lang.String toString()
```
    Provide access to the raw value.
    
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Forwards to raw value.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(MFDecimal o)
```
    Comparison operator: equal.
  - lte
```
public boolean lte(MFDecimal o)
```
    Comparison operator: less-than or equal. Will throw UnsupportedOperationException if either of the objects is not valid.
  - gte
```
public boolean gte(MFDecimal o)
```
    Comparison operator: greater-than or equal. Will throw UnsupportedOperationException if either of the objects is not valid.
  - lt
```
public boolean lt(MFDecimal o)
```
    Comparison operator: less-than. Will throw UnsupportedOperationException if either of the objects is not valid.
  - gt
```
public boolean gt(MFDecimal o)
```
    Comparison operator: greater-than. Will throw UnsupportedOperationException if either of the objects is not valid.
  - neg
```
public MFDecimal neg()
```
    Negate value.
  - abs
```
public MFDecimal abs()
```
    Absolute value.
  - compareTo
```
public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException
```
    Implements Comparable method compareTo.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Throws:
    
    java.lang.ClassCastException
  - isValid
```
public static boolean isValid(MFDecimal o)
```
    Check if MFDecimal object has valid value.

Class MFDecimal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NMA

NDA

NA

ZERO

Constructor Detail

MFDecimal

Method Detail

valueOf

valueOf

valueOf

valueOf

toLong

toDouble

toString

hashCode

equals

lte

gte

lt

gt

neg

abs

compareTo

isValid