NumberValue (Protempa Framework 5.0-Alpha-4 API)

java.lang.Object
- org.protempa.proposition.value.NumberValue

All Implemented Interfaces:

Serializable, Comparable<NumberValue>, NumericalValue, OrderedValue, Value, ValueVisitable
```
public final class NumberValue
extends Object
implements NumericalValue, Comparable<NumberValue>, Serializable
```
Represents a number, either integral or floating point, with unbounded upper and lower limit (subject to available memory). Significant digits are preserved.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

NumberValue(BigDecimal num)

NumberValue(double num)

NumberValue(long num)

Constructors
Constructor and Description
`NumberValue(BigDecimal num)`
`NumberValue(double num)`
`NumberValue(long num)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(ValueVisitor valueVisitor)` Performs some processing on a value.
`NumberValueBuilder`	`asBuilder()`
`ValueComparator`	`compare(Value o)` Compares this value and another numerically, or checks this number value for membership in a value list.
`int`	`compareTo(NumberValue o)`
`double`	`doubleValue()` Gets this value as a double.
`boolean`	`equals(Object obj)`
`String`	`format(Format format)` Returns a string representing this value, formatted by the provided `Format`.
`BigDecimal`	`getBigDecimal()` Gets this value as a `BigDecimal`.
`String`	`getFormatted()` Returns a string representing this value for display purposes.
`static NumberValue`	`getInstance(BigDecimal num)`
`static NumberValue`	`getInstance(double num)` Gets an instance of `NumberValue` representing a `double`.
`static NumberValue`	`getInstance(long num)`
`Number`	`getNumber()` Gets this value as a number.
`NumberValue`	`getNumberValue()` Gets the number value component of this numerical value.
`ValueType`	`getType()` Returns this object's type, guaranteed not `null`.
`int`	`hashCode()`
`long`	`longValue()`
`static NumberValue`	`parse(String str)` Parses a number from a string.
`NumberValue`	`replace()` Returns a value from a cache that is equal to this one, if such a value exists.
`String`	`toString()`

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

- Constructor Detail
  - NumberValue
```
public NumberValue(long num)
```
  - NumberValue
```
public NumberValue(double num)
```
  - NumberValue
```
public NumberValue(BigDecimal num)
```
- Method Detail
  - parse
```
public static NumberValue parse(String str)
```
    Parses a number from a string. The parser expects a string of the format described in the javadoc for BigDecimal's string constructor.
    
    Parameters:
    
    str - a string representing a number.
    
    Returns:
    
    a NumberValue, or null if no number was found in the string.
  - getInstance
```
public static NumberValue getInstance(double num)
```
    Gets an instance of NumberValue representing a double.
    
    Parameters:
    
    num - a double.
    
    Returns:
    
    a NumberValue. Guaranteed not null.
  - getInstance
```
public static NumberValue getInstance(long num)
```
  - getInstance
```
public static NumberValue getInstance(BigDecimal num)
```
  - replace
```
public NumberValue replace()
```
    Description copied from interface: Value
    
    Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.
    
    Specified by:
    
    replace in interface Value
    
    Returns:
    
    a Value for which #equals(Value) is true.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(NumberValue o)
```
    Specified by:
    
    compareTo in interface Comparable<NumberValue>
  - getFormatted
```
public String getFormatted()
```
    Description copied from interface: Value
    
    Returns a string representing this value for display purposes.
    
    Specified by:
    
    getFormatted in interface Value
    
    Returns:
    
    a String. Guaranteed not null.
  - format
```
public String format(Format format)
```
    Description copied from interface: Value
    
    Returns a string representing this value, formatted by the provided Format.
    
    Specified by:
    
    format in interface Value
    
    Parameters:
    
    format - a Format. Passing in a null will result in the same behavior as Value.getFormatted().
    
    Returns:
    
    a String.
  - getType
```
public ValueType getType()
```
    Description copied from interface: Value
    
    Returns this object's type, guaranteed not null.
    
    Specified by:
    
    getType in interface Value
    
    Returns:
    
    a ValueType.
  - doubleValue
```
public double doubleValue()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a double.
    
    Specified by:
    
    doubleValue in interface NumericalValue
    
    Returns:
    
    a double.
  - longValue
```
public long longValue()
```
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a BigDecimal.
    
    Specified by:
    
    getBigDecimal in interface NumericalValue
    
    Returns:
    
    a BigDecimal.
  - compare
```
public ValueComparator compare(Value o)
```
    Compares this value and another numerically, or checks this number value for membership in a value list.
    
    Specified by:
    
    compare in interface Value
    
    Parameters:
    
    o - a Value.
    
    Returns:
    
    If the provided value is a NumericalValue, returns null ValueComparator.GREATER_THAN, ValueComparator.LESS_THAN or ValueComparator.EQUAL_TO depending on whether this value is numerically greater than, less than or equal to the value provided as argument. If the provided value is a ValueList, returns ValueComparator.IN if this object is a member of the list, or ValueComparator.NOT_IN if not. Otherwise, returns ValueComparator.UNKNOWN.
  - getNumber
```
public Number getNumber()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a number.
    
    Specified by:
    
    getNumber in interface NumericalValue
    
    Returns:
    
    a Number.
  - accept
```
public void accept(ValueVisitor valueVisitor)
```
    Description copied from interface: ValueVisitable
    
    Performs some processing on a value.
    
    Specified by:
    
    accept in interface ValueVisitable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getNumberValue
```
public NumberValue getNumberValue()
```
    Description copied from interface: NumericalValue
    
    Gets the number value component of this numerical value.
    
    Specified by:
    
    getNumberValue in interface NumericalValue
    
    Returns:
    
    a NumberValue.
  - asBuilder
```
public NumberValueBuilder asBuilder()
```
    Specified by:
    
    asBuilder in interface NumericalValue
    
    Specified by:
    
    asBuilder in interface OrderedValue
    
    Specified by:
    
    asBuilder in interface Value

Class NumberValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NumberValue

NumberValue

NumberValue

Method Detail

parse

getInstance

getInstance

getInstance

replace

hashCode

equals

compareTo

getFormatted

format

getType

doubleValue

longValue

getBigDecimal

compare

getNumber

accept

toString

getNumberValue

asBuilder