net.openhft.chronicle.core.util

Class Longs

java.lang.Object

net.openhft.chronicle.core.util.Longs

public final class Longs
extends Object

A collection of functional compositions to check and assert various requirements related to long values.

Method Summary

Modifier and Type	Method and Description
static LongPredicate	nonNegative() Returns a predicate that can test if a value is non-negative (i.e.
static <X extends RuntimeException> long	require(LongPredicate requirement, long value, Function<String,X> exceptionMapper) Returns the provided value after checking that it satisfies the provided requirement throwing a custom exception if the check fails.
static long	requireNonNegative(long value) Returns the provided value after checking that it is non-negative throwing an IllegalArgumentException if the check fails.
static long	requirePositive(long value) Returns the provided value after checking that it is positive throwing an IllegalArgumentException if the check fails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

requireNonNegative

public static long requireNonNegative(long value)

Returns the provided value after checking that it is non-negative throwing an IllegalArgumentException if the check fails.

This method is designed primarily for doing parameter validation in public methods and constructors, as demonstrated below:

 public Foo(long bar) {
     this.bar = requireNonNegative(bar);
 }
 

Parameters:

value - the value to check

Returns:

the provided value if the check passes

Throws:

IllegalArgumentException - If the check fails

requirePositive

public static long requirePositive(long value)

Returns the provided value after checking that it is positive throwing an IllegalArgumentException if the check fails.

This method is designed primarily for doing parameter validation in public methods and constructors, as demonstrated below:

 public Foo(long bar) {
     this.bar = requirePositive(bar);
 }
 

Parameters:

value - the value to check

Returns:

the provided value if the check passes

Throws:

IllegalArgumentException - If the check fails

require

public static <X extends RuntimeException> long require(LongPredicate requirement,
                                                        long value,
                                                        Function<String,X> exceptionMapper)

Returns the provided value after checking that it satisfies the provided requirement throwing a custom exception if the check fails.

This method is designed primarily for doing parameter validation in public methods and constructors, as demonstrated below:

 public Foo(long bar) {
     this.bar = require(byteConvertible(), bar, ArithmeticException::new);
 }
 

Type Parameters:

X - Exception typ to throw if the check fails

Parameters:

requirement - to impose on the provided value

value - the value to check

exceptionMapper - to apply should the check fail

Returns:

the provided value if the check passes

Throws:

NullPointerException - If the provided requirement is null or if the provided exceptionMapper is null.

RuntimeException - of the specified type of the provided exceptionMapper

nonNegative

public static LongPredicate nonNegative()

Returns a predicate that can test if a value is non-negative (i.e. value >= 0).

This is equivalent to: negative().negate()

Returns:

a predicate that can test if a value is non-negative (i.e. value >= 0)