enumj

Class Checks

java.lang.Object

enumj.Checks

final class Checks
extends Object

Utility class containing check methods.

Constructor Summary

Constructors

Constructor and Description
Checks()

Method Summary

Modifier and Type	Method and Description
static void	ensureLessThan(long something, long limit, String message) Checks whether something is less than a limit.
static void	ensureNonEnumerating(Enumerable<?> enumerable) Checks that an enumerable is not enumerating.
static void	ensureNonEnumerating(Enumerator<?> enumerator) Checks that an enumerator is not enumerating.
static void	ensureNonNegative(long something, String message) Checks whether something is not negative.
static <T> void	ensureNotNull(T something, String message) Checks whether something is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

Checks

Checks()

Method Detail

ensureNotNull

public static <T> void ensureNotNull(T something,
                                     String message)

Checks whether something is not null.

Type Parameters:

T - type of something.

Parameters:

something - object to check for null.

message - error message.

Throws:

IllegalArgumentException - something is null.

ensureNonNegative

public static void ensureNonNegative(long something,
                                     String message)

Checks whether something is not negative.

Parameters:

something - long value to check.

message - error message.

Throws:

IllegalArgumentException - something is negative.

ensureLessThan

public static void ensureLessThan(long something,
                                  long limit,
                                  String message)

Checks whether something is less than a limit.

Parameters:

something - long value to check.

limit - long limit to check against.

message - error message.

Throws:

IllegalArgumentException - something is not less than the given limit.

ensureNonEnumerating

public static void ensureNonEnumerating(Enumerator<?> enumerator)

Checks that an enumerator is not enumerating.

Parameters:

enumerator - Enumerator to check.

Throws:

IllegalStateException - enumerator is enumerating.

See Also:

Enumerator.enumerating()

ensureNonEnumerating

public static void ensureNonEnumerating(Enumerable<?> enumerable)

Checks that an enumerable is not enumerating.

Parameters:

enumerable - Enumerable to check.

Throws:

IllegalStateException - enumerable is enumerating.

See Also:

Enumerable.enumerating()