SingleDecimal (Purity 0.14 API)

java.lang.Object
- com.willhains.purity.SingleDecimal<This>

Type Parameters:

This - Self-reference to the subclass type itself.

All Implemented Interfaces:

SingleComparable<This>, SingleNumber<This>, Comparable<This>, Supplier<BigDecimal>
```
public abstract class SingleDecimal<This extends SingleDecimal<This>>
extends Object
implements SingleNumber<This>, Supplier<BigDecimal>
```
A value type wrapping a BigDecimal.

Author:

willhains

Field Summary

Fields
Modifier and Type Field Description

protected BigDecimal raw
The raw underlying value.

Fields
Modifier and Type	Field	Description
`protected BigDecimal`	`raw`	The raw underlying value.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SingleDecimal(double rawValue, Function<? super BigDecimal,? extends This> constructor)`
`protected`	`SingleDecimal(String rawValue, Function<? super BigDecimal,? extends This> constructor)`
`protected`	`SingleDecimal(BigDecimal rawValue, Function<? super BigDecimal,? extends This> constructor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BigDecimal`	`asNumber()`
`int`	`compareTo(This that)`
`int`	`compareToNumber(Number number)`
`This`	`divideBy(Number number)`
`boolean`	`equals(Object other)`
`boolean`	`equals(This that)`
`Optional<This>`	`filter(Predicate<? super BigDecimal> condition)`	Test the raw value by `condition`.
`This`	`flatMap(Function<? super BigDecimal,? extends This> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`BigDecimal`	`get()`
`int`	`hashCode()`
`boolean`	`is(Predicate<? super BigDecimal> condition)`	Test the raw value with `condition`.
`boolean`	`isNegative()`
`boolean`	`isNot(Predicate<? super BigDecimal> condition)`	Reverse of `is(Predicate)`.
`boolean`	`isPositive()`
`boolean`	`isZero()`
`This`	`map(Function<? super BigDecimal,? extends BigDecimal> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`This`	`minus(Number number)`
`This`	`multiplyBy(Number number)`
`This`	`plus(Number number)`
`BigDecimal`	`raw()`
`This`	`round()`
`This`	`roundDown()`
`This`	`roundToPrecision(int decimals)`
`This`	`roundUp()`
`String`	`toString()`

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

Methods inherited from interface com.willhains.purity.SingleComparable
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, max, min

Methods inherited from interface com.willhains.purity.SingleNumber
divideBy, divideBy, format, format, isGreaterThan, isGreaterThan, isGreaterThanOrEqualTo, isGreaterThanOrEqualTo, isLessThan, isLessThan, isLessThanOrEqualTo, isLessThanOrEqualTo, isNonZero, minus, minus, multiplyBy, multiplyBy, plus, plus

- Field Detail
  - raw
```
protected final BigDecimal raw
```
    The raw underlying value. This property should be used only when passing the underlying value to external APIs. As much as possible, use the wrapped value type.
- Constructor Detail
  - SingleDecimal
```
protected SingleDecimal(BigDecimal rawValue,
                        Function<? super BigDecimal,? extends This> constructor)
```
    Parameters:
    
    rawValue - The raw, immutable value this object will represent.
    
    constructor - A method reference to the constructor of the implementing subclass.
  - SingleDecimal
```
protected SingleDecimal(double rawValue,
                        Function<? super BigDecimal,? extends This> constructor)
```
    Parameters:
    
    rawValue - The raw, immutable value this object will represent.
    
    constructor - A method reference to the constructor of the implementing subclass.
  - SingleDecimal
```
protected SingleDecimal(String rawValue,
                        Function<? super BigDecimal,? extends This> constructor)
```
    Parameters:
    
    rawValue - The raw, immutable value this object will represent.
    
    constructor - A method reference to the constructor of the implementing subclass.
- Method Detail
  - raw
```
public final BigDecimal raw()
```
  - get
```
public BigDecimal get()
```
    Specified by:
    
    get in interface Supplier<This extends SingleDecimal<This>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asNumber
```
public BigDecimal asNumber()
```
    Specified by:
    
    asNumber in interface SingleNumber<This extends SingleDecimal<This>>
  - compareTo
```
public final int compareTo(This that)
```
    Specified by:
    
    compareTo in interface Comparable<This extends SingleDecimal<This>>
  - compareToNumber
```
public final int compareToNumber(Number number)
```
    Specified by:
    
    compareToNumber in interface SingleNumber<This extends SingleDecimal<This>>
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface SingleNumber<This extends SingleDecimal<This>>
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface SingleNumber<This extends SingleDecimal<This>>
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface SingleNumber<This extends SingleDecimal<This>>
  - plus
```
public final This plus(Number number)
```
    Specified by:
    
    plus in interface SingleNumber<This extends SingleDecimal<This>>
  - minus
```
public final This minus(Number number)
```
    Specified by:
    
    minus in interface SingleNumber<This extends SingleDecimal<This>>
  - multiplyBy
```
public final This multiplyBy(Number number)
```
    Specified by:
    
    multiplyBy in interface SingleNumber<This extends SingleDecimal<This>>
  - divideBy
```
public final This divideBy(Number number)
```
    Specified by:
    
    divideBy in interface SingleNumber<This extends SingleDecimal<This>>
  - round
```
public final This round()
```
  - roundUp
```
public final This roundUp()
```
  - roundDown
```
public final This roundDown()
```
  - roundToPrecision
```
public final This roundToPrecision(int decimals)
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - equals
```
public final boolean equals(This that)
```
  - is
```
public final boolean is(Predicate<? super BigDecimal> condition)
```
    Test the raw value with condition. This method is useful when using Optional.filter(java.util.function.Predicate<? super T>) or Stream.filter(java.util.function.Predicate<? super T>).
```
 optional.filter(x -> x.is(String::isEmpty))
 
```
    Parameters:
    
    condition - a Predicate that tests the raw value type.
    
    Returns:
    
    true if the underlying raw value satisfies condition; false otherwise.
  - isNot
```
public final boolean isNot(Predicate<? super BigDecimal> condition)
```
    Reverse of is(Predicate).
  - filter
```
public final Optional<This> filter(Predicate<? super BigDecimal> condition)
```
    Test the raw value by condition.
    
    Returns:
    
    an Optional containing this instance if the condition is met; empty otherwise.
    
    See Also:
    
    is(Predicate)
  - map
```
public final This map(Function<? super BigDecimal,? extends BigDecimal> mapper)
```
    Construct a new value of this type with the raw underlying value converted by mapper.
    
    Parameters:
    
    mapper - The mapping function to apply to the raw underlying value.
    
    Returns:
    
    A new instance of this type.
  - flatMap
```
public final This flatMap(Function<? super BigDecimal,? extends This> mapper)
```
    Construct a new value of this type with the raw underlying value converted by mapper.
    
    Parameters:
    
    mapper - The mapping function to apply to the raw underlying value.
    
    Returns:
    
    The value returned by mapper.

Class SingleDecimal<This extends SingleDecimal<This>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.willhains.purity.SingleComparable

Methods inherited from interface com.willhains.purity.SingleNumber

Field Detail

raw

Constructor Detail

SingleDecimal

SingleDecimal

SingleDecimal

Method Detail

raw

get

toString

asNumber

compareTo

compareToNumber

isZero

isPositive

isNegative

plus

minus

multiplyBy

divideBy

round

roundUp

roundDown

roundToPrecision

hashCode

equals

equals

is

isNot

filter

map

flatMap