ome.smuggler.core.types

Class Nat

java.lang.Object

util.object.AbstractWrapper<T>

util.object.Wrapper<java.lang.Long>

ome.smuggler.core.types.Nat

All Implemented Interfaces:

java.util.function.Supplier<java.lang.Long>

public class Nat
extends util.object.Wrapper<java.lang.Long>

A natural number, i.e. an integer greater than or equal to zero.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Predicate<java.lang.Long>	isValid Test to check if a long can be used to instantiate a Nat.

Fields inherited from class util.object.Wrapper

wrappedValue

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<Nat>	from(long value) Instantiate a Nat from the given value only if it's not negative.
static Nat	of(long nonNegativeValue) Instantiate a Nat from a non-negative value.

Methods inherited from class util.object.Wrapper

get

Methods inherited from class util.object.AbstractWrapper

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

isValid

public static final java.util.function.Predicate<java.lang.Long> isValid

Test to check if a long can be used to instantiate a Nat.

Method Detail

from

public static java.util.Optional<Nat> from(long value)

Instantiate a Nat from the given value only if it's not negative.

Parameters:

value - the value to use.

Returns:

a Nat wrapping the given value or empty if the value is negative.

of

public static Nat of(long nonNegativeValue)

Instantiate a Nat from a non-negative value.

Parameters:

nonNegativeValue - the value to use.

Returns:

a Nat wrapping the given value.

Throws:

java.lang.IllegalArgumentException - if the value is negative.