SingleInt (Purity 0.14 API)

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

Type Parameters:

This - Self-reference to the subclass type itself.

All Implemented Interfaces:

SingleComparable<This>, SingleNumber<This>, Comparable<This>, IntSupplier
```
public abstract class SingleInt<This extends SingleInt<This>>
extends Object
implements SingleNumber<This>, IntSupplier
```
A primitive `int` version of Single.

Author:

willhains

Field Summary

Fields
Modifier and Type Field Description

protected int raw
The raw underlying value.

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

Constructor Summary

Constructors
Modifier Constructor Description

protected SingleInt(int rawValue, IntFunction<? extends This> constructor)

Constructors
Modifier	Constructor	Description
`protected`	`SingleInt(int rawValue, IntFunction<? extends This> constructor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`asNumber()`
`int`	`compareTo(This that)`
`int`	`compareToNumber(int number)`
`int`	`compareToNumber(Number number)`
`This`	`divideBy(int number)`
`This`	`divideBy(Number number)`
`This`	`divideBy(IntSupplier number)`
`boolean`	`equals(Object other)`
`boolean`	`equals(This that)`
`Optional<This>`	`filter(IntPredicate condition)`	Test the raw value by `condition`.
`This`	`flatMap(IntFunction<? extends This> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`int`	`getAsInt()`
`int`	`hashCode()`
`boolean`	`is(IntPredicate condition)`	Test the raw value with `condition`.
`boolean`	`isGreaterThan(IntSupplier number)`
`boolean`	`isGreaterThanOrEqualTo(IntSupplier number)`
`boolean`	`isLessThan(IntSupplier number)`
`boolean`	`isLessThanOrEqualTo(IntSupplier number)`
`boolean`	`isNegative()`
`boolean`	`isNot(IntPredicate condition)`	Reverse of `is(IntPredicate)`.
`boolean`	`isPositive()`
`boolean`	`isZero()`
`This`	`map(IntUnaryOperator mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`This`	`minus(int number)`
`This`	`minus(Number number)`
`This`	`minus(IntSupplier number)`
`This`	`multiplyBy(int number)`
`This`	`multiplyBy(Number number)`
`This`	`multiplyBy(IntSupplier number)`
`This`	`plus(int number)`
`This`	`plus(Number number)`
`This`	`plus(IntSupplier number)`
`int`	`raw()`	Return the raw underlying value.
`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 int 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
  - SingleInt
```
protected SingleInt(int rawValue,
                    IntFunction<? 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 int raw()
```
    Return the raw underlying value.
  - getAsInt
```
public int getAsInt()
```
    Specified by:
    
    getAsInt in interface IntSupplier
  - 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 Integer asNumber()
```
    Specified by:
    
    asNumber in interface SingleNumber<This extends SingleInt<This>>
  - compareTo
```
public final int compareTo(This that)
```
    Specified by:
    
    compareTo in interface Comparable<This extends SingleInt<This>>
  - compareToNumber
```
public final int compareToNumber(Number number)
```
    Specified by:
    
    compareToNumber in interface SingleNumber<This extends SingleInt<This>>
  - compareToNumber
```
public final int compareToNumber(int number)
```
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface SingleNumber<This extends SingleInt<This>>
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface SingleNumber<This extends SingleInt<This>>
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface SingleNumber<This extends SingleInt<This>>
  - plus
```
public final This plus(Number number)
```
    Specified by:
    
    plus in interface SingleNumber<This extends SingleInt<This>>
  - minus
```
public final This minus(Number number)
```
    Specified by:
    
    minus in interface SingleNumber<This extends SingleInt<This>>
  - multiplyBy
```
public final This multiplyBy(Number number)
```
    Specified by:
    
    multiplyBy in interface SingleNumber<This extends SingleInt<This>>
  - divideBy
```
public final This divideBy(Number number)
```
    Specified by:
    
    divideBy in interface SingleNumber<This extends SingleInt<This>>
  - plus
```
public final This plus(int number)
```
  - minus
```
public final This minus(int number)
```
  - multiplyBy
```
public final This multiplyBy(int number)
```
  - divideBy
```
public final This divideBy(int number)
```
  - plus
```
public final This plus(IntSupplier number)
```
  - minus
```
public final This minus(IntSupplier number)
```
  - multiplyBy
```
public final This multiplyBy(IntSupplier number)
```
  - divideBy
```
public final This divideBy(IntSupplier number)
```
  - isGreaterThan
```
public final boolean isGreaterThan(IntSupplier number)
```
  - isGreaterThanOrEqualTo
```
public final boolean isGreaterThanOrEqualTo(IntSupplier number)
```
  - isLessThan
```
public final boolean isLessThan(IntSupplier number)
```
  - isLessThanOrEqualTo
```
public final boolean isLessThanOrEqualTo(IntSupplier number)
```
  - is
```
public final boolean is(IntPredicate 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(IntPredicate condition)
```
    Reverse of is(IntPredicate).
  - filter
```
public final Optional<This> filter(IntPredicate condition)
```
    Test the raw value by condition.
    
    Returns:
    
    an Optional containing this instance if the condition is met; empty otherwise.
    
    See Also:
    
    is(IntPredicate)
  - map
```
public final This map(IntUnaryOperator 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(IntFunction<? 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 SingleInt<This extends SingleInt<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

SingleInt

Method Detail

raw

getAsInt

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