net.openhft.chronicle.core.util

Class Ints

java.lang.Object

net.openhft.chronicle.core.util.Ints

Deprecated.

@Deprecated
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(IntBiPredicate requirement, int value, int otherValue) Deprecated. Asserts that the provided value and provided otherValue satisfies the provided requirement if assertions is enabled (i.e.
static boolean	assertIfEnabled(IntPredicate requirement, int value) Deprecated. Asserts that the provided value satisfies the provided requirement if assertions is enabled (i.e.
static boolean	assertIfEnabled(IntTriPredicate requirement, int value, int otherFirstValue, int otherSecondValue) Deprecated. Asserts that the provided value, provided otherFirstValue and provided otherSecondValue satisfies the provided requirement if assertions is enabled (i.e.
static IntTriPredicate	between() Deprecated. Returns a predicate that can test if a value is between another first value (inclusive) and another second value (exclusive) (i.e value ∈ [other first value , other second value) ).
static IntTriPredicate	betweenClosed() Deprecated. Returns a predicate that can test if a value is between (closed) another first value (inclusive) and another second value (inclusive) (i.e value ∈ [other first value , other second value] ).
static IntBiPredicate	betweenZeroAnd() Deprecated. Returns a predicate that can test if a value is between zero and another value (exclusive) (i.e value ∈ [0, other value) ).
static IntBiPredicate	betweenZeroAndClosed() Deprecated. Returns a predicate that can test if a value is between zero and another value (inclusive) (i.e value ∈ [0, other value] ).
static IntTriPredicate	betweenZeroAndReserving() Deprecated. Returns a predicate that can test if a value is between zero and another first value (inclusive) whilst ensuring a value of size defined by another second value can fit.
static IntPredicate	byteConvertible() Deprecated. Returns a predicate that can test if a value can fit in a byte (i.e.
static IntBiPredicate	equalTo() Deprecated. Returns a predicate that can test if a value is equal to another value.
static IntPredicate	evenPowerOfTwo() Deprecated. Returns a predicate that can test if a value is an even power of two (i.e.
static String	failDescription(IntBiPredicate requirement, int value, int otherValue) Deprecated. Returns a human-readable form of a failure message provided that the provided value and provided otherValue did not satisfy the provided requirement.
static String	failDescription(IntPredicate requirement, int value) Deprecated. Returns a human-readable form of a failure message provided that the provided value did not satisfy the provided requirement.
static String	failDescription(IntTriPredicate requirement, int value, int otherFirstValue, int otherSecondValue) Deprecated. Returns a human-readable form of a failure message provided that the provided value, provided otherFirstValue and provided otherFirstValue did not satisfy the provided requirement.
static IntBiPredicate	greaterOrEqual() Deprecated. Returns a predicate that can test if a value is greater or equal to another value.
static IntBiPredicate	greaterThan() Deprecated. Returns a predicate that can test if a value is greater than to another value.
static IntPredicate	intAligned() Deprecated. Returns a predicate that can test if a value is int aligned (i.e.
static IntBiPredicate	lessOrEqual() Deprecated. Returns a predicate that can test if a value is less or equal to another value.
static IntBiPredicate	lessThan() Deprecated. Returns a predicate that can test if a value is less than to another value.
static IntBiPredicate	log2() Deprecated. Returns a predicate that can test if a value is log2 of another value (i.e.
static IntPredicate	longAligned() Deprecated. Returns a predicate that can test if a value is long aligned (i.e.
static IntPredicate	negative() Deprecated. Returns a predicate that can test if a value is negative (i.e.
static IntPredicate	nonNegative() Deprecated. Returns a predicate that can test if a value is non-negative (i.e.
static IntPredicate	positive() Deprecated. Returns a predicate that can test if a value is positive (i.e.
static IntBiPredicate	powerOfTwo() Deprecated. Returns a predicate that can test if a value is a power of two of another value (i.e.
static int	require(IntBiPredicate requirement, int value, int otherValue) Deprecated. Returns the provided value after checking that it and the provided otherValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.
static <X extends RuntimeException> int	require(IntBiPredicate requirement, int value, int otherValue, Function<String,X> exceptionMapper) Deprecated. Returns the provided value after checking that it and the provided otherValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.
static int	require(IntPredicate requirement, int value) Deprecated. Returns the provided value after checking that it satisfies the provided requirement throwing an IllegalArgumentException if the check fails.
static <X extends RuntimeException> int	require(IntPredicate requirement, int value, Function<String,X> exceptionMapper) Deprecated. Returns the provided value after checking that it satisfies the provided requirement throwing a custom exception if the check fails.
static int	require(IntTriPredicate requirement, int value, int otherFirstValue, int otherSecondValue) Deprecated. Returns the provided value after checking that it and the provided otherValue and the provided otherSecondValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.
static <X extends RuntimeException> int	require(IntTriPredicate requirement, int value, int otherFirstValue, int otherSecondValue, Function<String,X> exceptionMapper) Deprecated. Returns the provided value after checking that it and the provided otherValue and the provided otherSecondValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.
static int	requireNonNegative(int value) Deprecated. Returns the provided value after checking that it is non-negative throwing an IllegalArgumentException if the check fails.
static IntPredicate	shortAligned() Deprecated. Returns a predicate that can test if a value is short aligned (i.e.
static IntPredicate	shortConvertible() Deprecated. Returns a predicate that can test if a value can fit in a short (i.e.
static IntPredicate	zero() Deprecated. Returns a predicate that can test if a value is zero (i.e.

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)

Deprecated.

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

require

public static int require(IntPredicate requirement,
                          int value)

Deprecated.

Returns the provided value after checking that it satisfies the provided requirement 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 = require(nonNegative(), bar);
 }
 

Parameters:

requirement - to impose on the provided value

value - the value to check

Returns:

the provided value if the check passes

Throws:

NullPointerException - if the provided requirement is null.

IllegalArgumentException - if the check fails

require

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

Deprecated.

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(int 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

require

public static int require(IntBiPredicate requirement,
                          int value,
                          int otherValue)

Deprecated.

Returns the provided value after checking that it and the provided otherValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.

Checks that the provided value and provided otherValue satisfies the provided requirement.

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

 public Foo(int bar) {
     this.bar = require(betweenZeroAnd(), bar, 32);
 }
 

Parameters:

requirement - to impose on the provided value and otherValue

value - the value to check

otherValue - the other value to compare against the provided value

Returns:

the provided value if the check passes

Throws:

NullPointerException - if the provided requirement is null.

IllegalArgumentException - if the check fails

require

public static <X extends RuntimeException> int require(IntBiPredicate requirement,
                                                       int value,
                                                       int otherValue,
                                                       Function<String,X> exceptionMapper)

Deprecated.

Returns the provided value after checking that it and the provided otherValue satisfies the provided requirement throwing an IllegalArgumentException if the check fails.

Checks that the provided value and provided otherValue satisfies the provided requirement.

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

 public Foo(int bar) {
     this.bar = require(betweenZeroAnd(), bar, 16, 32, ArithmeticException::new);
 }
 

Type Parameters:

X - Exception typ to throw if the check fails

Parameters:

requirement - to impose on the provided value and otherValue

value - the value to check

otherValue - the other value to compare against the provided value

exceptionMapper - to apply should the check fail

Returns:

the provided value if the check passes

Throws:

NullPointerException - if the provided requirement is null.

IllegalArgumentException - if the check fails

require

public static int require(IntTriPredicate requirement,
                          int value,
                          int otherFirstValue,
                          int otherSecondValue)

Deprecated.

Returns the provided value after checking that it and the provided otherValue and the provided otherSecondValue satisfies the provided requirement 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 = require(between(), bar, 16, 32);
 }
 

Parameters:

requirement - to impose on the provided values

value - the value to check

otherFirstValue - the other first value to compare against the provided value

otherSecondValue - the other first value to compare against the provided value

Returns:

the provided value if the check passes

Throws:

NullPointerException - if the provided requirement is null.

IllegalArgumentException - if the check fails

require

public static <X extends RuntimeException> int require(IntTriPredicate requirement,
                                                       int value,
                                                       int otherFirstValue,
                                                       int otherSecondValue,
                                                       Function<String,X> exceptionMapper)

Deprecated.

Returns the provided value after checking that it and the provided otherValue and the provided otherSecondValue satisfies the provided requirement 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 = require(between(), bar, 16, 32, ArithmeticException::new);
 }
 

Type Parameters:

X - Exception typ to throw if the check fails

Parameters:

requirement - to impose on the provided values

value - the value to check

otherFirstValue - the other first value to compare against the provided value

otherSecondValue - the other first value to compare against the provided value

exceptionMapper - to apply should the check fail

Returns:

the provided value if the check passes

Throws:

NullPointerException - if the provided requirement is null.

IllegalArgumentException - if the check fails

assertIfEnabled

public static boolean assertIfEnabled(IntPredicate requirement,
                                      int value)

Deprecated.

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.

assertIfEnabled

public static boolean assertIfEnabled(IntBiPredicate requirement,
                                      int value,
                                      int otherValue)

Deprecated.

Asserts that the provided value and provided otherValue 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(betweenZeroAnd(), bar, 32);
     this.bar = bar;
 }
 

Parameters:

requirement - to impose on the provided value and otherValue

value - the value to check

otherValue - the other value to compare against the provided value

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.

assertIfEnabled

public static boolean assertIfEnabled(IntTriPredicate requirement,
                                      int value,
                                      int otherFirstValue,
                                      int otherSecondValue)

Deprecated.

Asserts that the provided value, provided otherFirstValue and provided otherSecondValue 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:

 public private(int bar) {
     assertIfEnabled(between(), bar, 13, 42);
     this.bar = bar;
 }
 

Parameters:

requirement - to impose on the provided values

value - the value to check

otherFirstValue - the other first value to compare against the provided value

otherSecondValue - the other first value to compare against the provided value

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)

Deprecated.

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.

failDescription

public static String failDescription(IntBiPredicate requirement,
                                     int value,
                                     int otherValue)

Deprecated.

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

Parameters:

requirement - to imposed on the provided values

value - the value to check

otherValue - the other value to compare against the provided value

Returns:

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

Throws:

NullPointerException - if the provided requirement is null.

failDescription

public static String failDescription(IntTriPredicate requirement,
                                     int value,
                                     int otherFirstValue,
                                     int otherSecondValue)

Deprecated.

Returns a human-readable form of a failure message provided that the provided value, provided otherFirstValue and provided otherFirstValue 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 and provided otherValue did not satisfy the provided requirement

Throws:

NullPointerException - if the provided requirement is null.

positive

public static IntPredicate positive()

Deprecated.

Returns a predicate that can test if a value is positive (i.e. value > 0).

Returns:

a predicate that can test if a value is positive (i.e. value > 0)

negative

public static IntPredicate negative()

Deprecated.

Returns a predicate that can test if a value is negative (i.e. value < 0).

Returns:

a predicate that can test if a value is negative (i.e. value < 0)

nonNegative

public static IntPredicate nonNegative()

Deprecated.

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)

zero

public static IntPredicate zero()

Deprecated.

Returns a predicate that can test if a value is zero (i.e. value == 0).

Returns:

a predicate that can test if a value is zero (i.e. value == 0)

byteConvertible

public static IntPredicate byteConvertible()

Deprecated.

Returns a predicate that can test if a value can fit in a byte (i.e. value ∈ [-128, 127]").

Returns:

a predicate that can test if a value can fit in a byte (i.e. value ∈ [-128, 127]")

shortConvertible

public static IntPredicate shortConvertible()

Deprecated.

Returns a predicate that can test if a value can fit in a short (i.e. value ∈ [-32768, 32767]").

Returns:

a predicate that can test if a value can fit in a short (i.e. value ∈ [-32768, 32767]")

evenPowerOfTwo

public static IntPredicate evenPowerOfTwo()

Deprecated.

Returns a predicate that can test if a value is an even power of two (i.e. log2(value) is an integer).

Returns:

a predicate that can test if a value is an even power of two (i.e. log2(value) is an integer)

shortAligned

public static IntPredicate shortAligned()

Deprecated.

Returns a predicate that can test if a value is short aligned (i.e. value & (Short.BYTES - 1) == 0).

Returns:

a predicate that can test if a value is short aligned (i.e. value & (Short.BYTES - 1) == 0)

intAligned

public static IntPredicate intAligned()

Deprecated.

Returns a predicate that can test if a value is int aligned (i.e. value & (Integer.BYTES - 1) == 0).

Returns:

a predicate that can test if a value is a int aligned (i.e. value & (Integer.BYTES - 1) == 0)

longAligned

public static IntPredicate longAligned()

Deprecated.

Returns a predicate that can test if a value is long aligned (i.e. value & (Long.BYTES - 1) == 0).

Returns:

a predicate that can test if a value is a long aligned (i.e. value & (Long.BYTES - 1) == 0)

equalTo

public static IntBiPredicate equalTo()

Deprecated.

Returns a predicate that can test if a value is equal to another value.

Returns:

a predicate that can test if a value is equal to another value

greaterThan

public static IntBiPredicate greaterThan()

Deprecated.

Returns a predicate that can test if a value is greater than to another value.

Returns:

a predicate that can test if a value is greater than to another value

greaterOrEqual

public static IntBiPredicate greaterOrEqual()

Deprecated.

Returns a predicate that can test if a value is greater or equal to another value.

Returns:

a predicate that can test if a value is greater or equal to another value

lessThan

public static IntBiPredicate lessThan()

Deprecated.

Returns a predicate that can test if a value is less than to another value.

Returns:

a predicate that can test if a value is less than to another value

lessOrEqual

public static IntBiPredicate lessOrEqual()

Deprecated.

Returns a predicate that can test if a value is less or equal to another value.

Returns:

a predicate that can test if a value is less or equal to another value

betweenZeroAnd

public static IntBiPredicate betweenZeroAnd()

Deprecated.

Returns a predicate that can test if a value is between zero and another value (exclusive) (i.e value ∈ [0, other value) ).

Returns:

a predicate that can test if a value is between zero and another value (exclusive) (i.e value ∈ [0, other value) )

betweenZeroAndClosed

public static IntBiPredicate betweenZeroAndClosed()

Deprecated.

Returns a predicate that can test if a value is between zero and another value (inclusive) (i.e value ∈ [0, other value] ).

Returns:

a predicate that can test if a value is between zero and another value (inclusive) (i.e value ∈ [0, other value] )

powerOfTwo

public static IntBiPredicate powerOfTwo()

Deprecated.

Returns a predicate that can test if a value is a power of two of another value (i.e. value = 2 ^ other value). For example, powerOfTwo().test(16, 4) is true because 2^4 is 16

Returns:

a predicate that can test if a value is an even power of two (i.e. an N exists such that value ^ N is an integer)

log2

public static IntBiPredicate log2()

Deprecated.

Returns a predicate that can test if a value is log2 of another value (i.e. value = log2(other value) ).

For example, log2().test(4, 16) is true because log2(16) is 4

Returns:

a predicate that can test if a value is log2 of another value (i.e. value = log2(other value) ).

between

public static IntTriPredicate between()

Deprecated.

Returns a predicate that can test if a value is between another first value (inclusive) and another second value (exclusive) (i.e value ∈ [other first value , other second value) ).

Returns:

a predicate that can test if a value is between another first value (inclusive) and another second value (exclusive) (i.e value ∈ [other first value , other second value) )

betweenClosed

public static IntTriPredicate betweenClosed()

Deprecated.

Returns a predicate that can test if a value is between (closed) another first value (inclusive) and another second value (inclusive) (i.e value ∈ [other first value , other second value] ).

Returns:

a predicate that can test if a value is between (closed) another first value (inclusive) and another second value (inclusive) (i.e value ∈ [other first value , other second value] ).

betweenZeroAndReserving

public static IntTriPredicate betweenZeroAndReserving()

Deprecated.

Returns a predicate that can test if a value is between zero and another first value (inclusive) whilst ensuring a value of size defined by another second value can fit. (i.e value ∈ [0, other first value - other second value] ).

This predicate is useful when ensuring that a memory structure can be updated without exceeding its upper bounds. For example:

 public static void putInt(byte[] bytes, int offset, int value) {
         assert nonNull(bytes);
         assert betweenZeroAndReserving.test(offset, bytes.length, Integer.BYTES);
         ...
 

Returns:

Returns a predicate that can test if a value is between zero and another first value (inclusive) whilst ensuring a value of size defined by another second value can fit. (i.e value ∈ [0, other first value - other second value] ).