SingleLong (Purity 0.14 API)

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

Type Parameters:

This - Self-reference to the subclass type itself.

All Implemented Interfaces:

SingleComparable<This>, SingleNumber<This>, Comparable<This>, LongSupplier
```
public abstract class SingleLong<This extends SingleLong<This>>
extends Object
implements SingleNumber<This>, LongSupplier
```
A primitive `long` version of Single.

Author:

willhains

Field Summary

Fields
Modifier and Type Field Description

protected long raw
The raw underlying value.

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

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SingleLong(long rawValue, LongFunction<? extends This> constructor)`	Equivalent to `SingleLong(rawValue, constructor, true)`.
`protected`	`SingleLong(long rawValue, LongFunction<? extends This> constructor, boolean applyRules)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Long`	`asNumber()`
`int`	`compareTo(This that)`
`int`	`compareToNumber(long number)`
`int`	`compareToNumber(Number number)`
`This`	`divideBy(long number)`
`This`	`divideBy(Number number)`
`This`	`divideBy(LongSupplier number)`
`boolean`	`equals(Object other)`
`boolean`	`equals(This that)`
`Optional<This>`	`filter(LongPredicate condition)`	Test the raw value by `condition`.
`This`	`flatMap(LongFunction<? extends This> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`long`	`getAsLong()`
`int`	`hashCode()`
`boolean`	`is(LongPredicate condition)`	Test the raw value with `condition`.
`boolean`	`isGreaterThan(LongSupplier number)`
`boolean`	`isGreaterThanOrEqualTo(LongSupplier number)`
`boolean`	`isLessThan(LongSupplier number)`
`boolean`	`isLessThanOrEqualTo(LongSupplier number)`
`boolean`	`isNegative()`
`boolean`	`isNot(LongPredicate condition)`	Reverse of `is(LongPredicate)`.
`boolean`	`isPositive()`
`boolean`	`isZero()`
`This`	`map(LongUnaryOperator mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`This`	`minus(long number)`
`This`	`minus(Number number)`
`This`	`minus(LongSupplier number)`
`This`	`multiplyBy(long number)`
`This`	`multiplyBy(Number number)`
`This`	`multiplyBy(LongSupplier number)`
`This`	`plus(long number)`
`This`	`plus(Number number)`
`This`	`plus(LongSupplier number)`
`long`	`raw()`
`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 long 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
  - SingleLong
```
protected SingleLong(long rawValue,
                     LongFunction<? extends This> constructor)
```
    Equivalent to SingleLong(rawValue, constructor, true).
  - SingleLong
```
protected SingleLong(long rawValue,
                     LongFunction<? extends This> constructor,
                     boolean applyRules)
```
    Parameters:
    
    rawValue - The raw, immutable value this object will represent.
    
    constructor - A method reference to the constructor of the implementing subclass.
    
    applyRules - Whether to apply rules to the raw value.
- Method Detail
  - raw
```
public final long raw()
```
  - getAsLong
```
public long getAsLong()
```
    Specified by:
    
    getAsLong in interface LongSupplier
  - 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 Long asNumber()
```
    Specified by:
    
    asNumber in interface SingleNumber<This extends SingleLong<This>>
  - compareTo
```
public final int compareTo(This that)
```
    Specified by:
    
    compareTo in interface Comparable<This extends SingleLong<This>>
  - compareToNumber
```
public final int compareToNumber(Number number)
```
    Specified by:
    
    compareToNumber in interface SingleNumber<This extends SingleLong<This>>
  - compareToNumber
```
public final int compareToNumber(long number)
```
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface SingleNumber<This extends SingleLong<This>>
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface SingleNumber<This extends SingleLong<This>>
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface SingleNumber<This extends SingleLong<This>>
  - plus
```
public final This plus(Number number)
```
    Specified by:
    
    plus in interface SingleNumber<This extends SingleLong<This>>
  - minus
```
public final This minus(Number number)
```
    Specified by:
    
    minus in interface SingleNumber<This extends SingleLong<This>>
  - multiplyBy
```
public final This multiplyBy(Number number)
```
    Specified by:
    
    multiplyBy in interface SingleNumber<This extends SingleLong<This>>
  - divideBy
```
public final This divideBy(Number number)
```
    Specified by:
    
    divideBy in interface SingleNumber<This extends SingleLong<This>>
  - plus
```
public final This plus(long number)
```
  - minus
```
public final This minus(long number)
```
  - multiplyBy
```
public final This multiplyBy(long number)
```
  - divideBy
```
public final This divideBy(long number)
```
  - plus
```
public final This plus(LongSupplier number)
```
  - minus
```
public final This minus(LongSupplier number)
```
  - multiplyBy
```
public final This multiplyBy(LongSupplier number)
```
  - divideBy
```
public final This divideBy(LongSupplier number)
```
  - isGreaterThan
```
public final boolean isGreaterThan(LongSupplier number)
```
  - isGreaterThanOrEqualTo
```
public final boolean isGreaterThanOrEqualTo(LongSupplier number)
```
  - isLessThan
```
public final boolean isLessThan(LongSupplier number)
```
  - isLessThanOrEqualTo
```
public final boolean isLessThanOrEqualTo(LongSupplier number)
```
  - is
```
public final boolean is(LongPredicate 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(LongPredicate condition)
```
    Reverse of is(LongPredicate).
  - filter
```
public final Optional<This> filter(LongPredicate condition)
```
    Test the raw value by condition.
    
    Returns:
    
    an Optional containing this instance if the condition is met; empty otherwise.
    
    See Also:
    
    is(LongPredicate)
  - map
```
public final This map(LongUnaryOperator 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(LongFunction<? 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 SingleLong<This extends SingleLong<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

SingleLong

SingleLong

Method Detail

raw

getAsLong

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

is

isNot

filter

map

flatMap