SingleDouble (Purity 0.14 API)

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

Type Parameters:

This - Self-reference to the subclass type itself.

All Implemented Interfaces:

SingleComparable<This>, SingleNumber<This>, Comparable<This>, DoubleSupplier
```
public abstract class SingleDouble<This extends SingleDouble<This>>
extends Object
implements SingleNumber<This>, DoubleSupplier
```
A primitive `double` version of Single.

Author:

willhains

Field Summary

Fields
Modifier and Type Field Description

protected double raw
The raw underlying value.

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

Constructor Summary

Constructors
Modifier Constructor Description

protected SingleDouble(double rawValue, DoubleFunction<? extends This> constructor)

Constructors
Modifier	Constructor	Description
`protected`	`SingleDouble(double rawValue, DoubleFunction<? extends This> constructor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Double`	`asNumber()`
`int`	`compareTo(This that)`
`int`	`compareToNumber(double number)`
`int`	`compareToNumber(Number number)`
`This`	`divideBy(double number)`
`This`	`divideBy(Number number)`
`This`	`divideBy(DoubleSupplier number)`
`boolean`	`equals(Object other)`
`boolean`	`equals(This that)`
`Optional<This>`	`filter(DoublePredicate condition)`	Test the raw value by `condition`.
`This`	`flatMap(DoubleFunction<? extends This> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`double`	`getAsDouble()`
`int`	`hashCode()`
`boolean`	`is(DoublePredicate condition)`	Test the raw value with `condition`.
`boolean`	`isGreaterThan(DoubleSupplier number)`
`boolean`	`isGreaterThanOrEqualTo(DoubleSupplier number)`
`boolean`	`isLessThan(DoubleSupplier number)`
`boolean`	`isLessThanOrEqualTo(DoubleSupplier number)`
`boolean`	`isNegative()`
`boolean`	`isNot(DoublePredicate condition)`	Reverse of `is(DoublePredicate)`.
`boolean`	`isPositive()`
`boolean`	`isZero()`
`This`	`map(DoubleUnaryOperator mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`This`	`minus(double number)`
`This`	`minus(Number number)`
`This`	`minus(DoubleSupplier number)`
`This`	`multiplyBy(double number)`
`This`	`multiplyBy(Number number)`
`This`	`multiplyBy(DoubleSupplier number)`
`This`	`plus(double number)`
`This`	`plus(Number number)`
`This`	`plus(DoubleSupplier number)`
`double`	`raw()`	Return the raw underlying value.
`This`	`round()`
`This`	`roundDown()`
`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 double 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
  - SingleDouble
```
protected SingleDouble(double rawValue,
                       DoubleFunction<? 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 double raw()
```
    Return the raw underlying value.
  - getAsDouble
```
public double getAsDouble()
```
    Specified by:
    
    getAsDouble in interface DoubleSupplier
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public final boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - equals
```
public final boolean equals(This that)
```
  - asNumber
```
public Double asNumber()
```
    Specified by:
    
    asNumber in interface SingleNumber<This extends SingleDouble<This>>
  - compareTo
```
public final int compareTo(This that)
```
    Specified by:
    
    compareTo in interface Comparable<This extends SingleDouble<This>>
  - compareToNumber
```
public final int compareToNumber(Number number)
```
    Specified by:
    
    compareToNumber in interface SingleNumber<This extends SingleDouble<This>>
  - compareToNumber
```
public final int compareToNumber(double number)
```
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface SingleNumber<This extends SingleDouble<This>>
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface SingleNumber<This extends SingleDouble<This>>
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface SingleNumber<This extends SingleDouble<This>>
  - plus
```
public final This plus(Number number)
```
    Specified by:
    
    plus in interface SingleNumber<This extends SingleDouble<This>>
  - minus
```
public final This minus(Number number)
```
    Specified by:
    
    minus in interface SingleNumber<This extends SingleDouble<This>>
  - multiplyBy
```
public final This multiplyBy(Number number)
```
    Specified by:
    
    multiplyBy in interface SingleNumber<This extends SingleDouble<This>>
  - divideBy
```
public final This divideBy(Number number)
```
    Specified by:
    
    divideBy in interface SingleNumber<This extends SingleDouble<This>>
  - plus
```
public final This plus(double number)
```
  - minus
```
public final This minus(double number)
```
  - multiplyBy
```
public final This multiplyBy(double number)
```
  - divideBy
```
public final This divideBy(double number)
```
  - plus
```
public final This plus(DoubleSupplier number)
```
  - minus
```
public final This minus(DoubleSupplier number)
```
  - multiplyBy
```
public final This multiplyBy(DoubleSupplier number)
```
  - divideBy
```
public final This divideBy(DoubleSupplier number)
```
  - isGreaterThan
```
public final boolean isGreaterThan(DoubleSupplier number)
```
  - isGreaterThanOrEqualTo
```
public final boolean isGreaterThanOrEqualTo(DoubleSupplier number)
```
  - isLessThan
```
public final boolean isLessThan(DoubleSupplier number)
```
  - isLessThanOrEqualTo
```
public final boolean isLessThanOrEqualTo(DoubleSupplier number)
```
  - round
```
public final This round()
```
  - roundUp
```
public final This roundUp()
```
  - roundDown
```
public final This roundDown()
```
  - is
```
public final boolean is(DoublePredicate 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($ -> $ > 0))
 
```
    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(DoublePredicate condition)
```
    Reverse of is(DoublePredicate).
  - filter
```
public final Optional<This> filter(DoublePredicate condition)
```
    Test the raw value by condition.
    
    Returns:
    
    an Optional containing this instance if the condition is met; empty otherwise.
    
    See Also:
    
    is(DoublePredicate)
  - map
```
public final This map(DoubleUnaryOperator 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(DoubleFunction<? 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 SingleDouble<This extends SingleDouble<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

SingleDouble

Method Detail

raw

getAsDouble

hashCode

toString

equals

equals

asNumber

compareTo

compareToNumber

compareToNumber

isZero

isPositive

isNegative

plus

minus

multiplyBy

divideBy

plus

minus

multiplyBy

divideBy

plus

minus

multiplyBy

divideBy

isGreaterThan

isGreaterThanOrEqualTo

isLessThan

isLessThanOrEqualTo

round

roundUp

roundDown

is

isNot

filter

map

flatMap