net.openhft.chronicle.core.util

Class Ints

java.lang.Object

net.openhft.chronicle.core.util.Ints

public final class Ints
extends Object

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

Method Summary

Modifier and Type	Method and Description
static boolean	assertIfEnabled(IntPredicate requirement, int value) Asserts that the provided value satisfies the provided requirement if assertions is enabled (i.e.
static String	failDescription(IntPredicate requirement, int value) Returns a human-readable form of a failure message provided that the provided value did not satisfy the provided requirement.
static IntPredicate	nonNegative() Returns a predicate that can test if a value is non-negative (i.e.
static int	requireNonNegative(int value) Returns the provided value after checking that it is non-negative 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 int requireNonNegative(int 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(int bar) {
     this.bar = requireNonNegative(bar);
 }
 

This method is functionally equivalent to:

     require(negative().negate(), value);
 

but is potentially optimized for performance.

Parameters:

value - the value to check

Returns:

the provided value if the check passes

Throws:

IllegalArgumentException - if the check fails

assertIfEnabled

public static boolean assertIfEnabled(IntPredicate requirement,
                                      int value)

Asserts that the provided value satisfies the provided requirement if assertions is enabled (i.e. -ea) and AssertUtil.SKIP_ASSERTIONS is false.

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

 private Foo(int bar) {
     assertIfEnabled(nonNegative, bar);
     this.bar = bar;
 }
 

Parameters:

requirement - to impose on the provided value

value - the value to check

Returns:

true

Throws:

NullPointerException - if the provided requirement is null. There is no guarantee that this exception is thrown. For example, if assertions are not enabled, then the exception might not be thrown.

AssertionError - if the check fails and assertions are enabled both via the -ea JVM command line option and by setting AssertUtil.SKIP_ASSERTIONS to false.

failDescription

public static String failDescription(IntPredicate requirement,
                                     int value)

Returns a human-readable form of a failure message provided that the provided value did not satisfy the provided requirement.

Parameters:

requirement - to imposed on the provided values

value - the value to check

Returns:

a human-readable form of a failure message provided that the provided value did not satisfy the provided requirement

Throws:

NullPointerException - if the provided requirement is null.

nonNegative

public static IntPredicate 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)