ch.trick17.betterchecks.fluent

Class PrimitiveArrayCheck

java.lang.Object

ch.trick17.betterchecks.fluent.BaseCheck<C>

ch.trick17.betterchecks.fluent.ObjectBaseCheck<Object,PrimitiveArrayCheck>

ch.trick17.betterchecks.fluent.PrimitiveArrayCheck

@GwtCompatible
public final class PrimitiveArrayCheck
extends ObjectBaseCheck<Object,PrimitiveArrayCheck>

The check class for all types of primitive arrays. There is no separate class for each primitive type of array. In addition to the array argument itself, a check of this class stores the length of the array, which is the only thing needed for the checks this class provides.

Author:

Michael Faes

Field Summary

Fields inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

arg, nullAllowed

Fields inherited from class ch.trick17.betterchecks.fluent.BaseCheck

argName, inverted

Constructor Summary

Constructors

Constructor and Description
PrimitiveArrayCheck(Object arg, int argLength) For internal use only.

Method Summary

Modifier and Type	Method and Description
PrimitiveArrayCheck	hasLength(int length) Checks that the array argument has the given length, throwing an exception otherwise.
PrimitiveArrayCheck	hasLengthBetween(int min, int max) Checks that the array argument's length is between the two given numbers, throwing an exception otherwise.
IntCheck	hasLengthWhich() Creates an IntCheck property check for the length of the array argument.
PrimitiveArrayCheck	isNotEmpty() Checks that the array argument is not empty (meaning it has a length greater than zero), throwing an exception otherwise.

Methods inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

check, checkNull, checkWithCause, hasClass, intPropertyCheck, isEqualTo, isInstanceOf, isNotNull, isNullOr, isSameAs, objectPropertyCheck

Methods inherited from class ch.trick17.betterchecks.fluent.BaseCheck

checkConversion, me, named, not

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimitiveArrayCheck

public PrimitiveArrayCheck(Object arg,
                           int argLength)

For internal use only.

Method Detail

isNotEmpty

public PrimitiveArrayCheck isNotEmpty()

Checks that the array argument is not empty (meaning it has a length greater than zero), throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_EMPTY.

Returns:

This check

Throws:

IllegalArgumentException - if the array argument is empty

hasLength

public PrimitiveArrayCheck hasLength(int length)

Checks that the array argument has the given length, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_LENGTH.

To create more sophisticated checks using the array length, use the hasLengthWhich() property check.

Parameters:

length - The length the array should have

Returns:

This check

Throws:

IllegalArgumentException - if the array argument has a length different from the given one.

See Also:

hasLengthBetween(int, int)

hasLengthBetween

public PrimitiveArrayCheck hasLengthBetween(int min,
                                            int max)

Checks that the array argument's length is between the two given numbers, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_LENGTH_BETWEEN.

To create more sophisticated checks using the array length, use the hasLengthWhich() property check.

Parameters:

min - The minimum length of the array

max - The maximum length

Returns:

This check

Throws:

IllegalArgumentException - If the length of the array is strictly less than min or strictly greater than max.

hasLengthWhich

public IntCheck hasLengthWhich()

Creates an IntCheck property check for the length of the array argument. It can be used to create advanced checks using the array length. For example:

Check.that(array).isNullOr().hasLengthWhich().isGreaterThan(3);

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the length of this check's array set as the argument and an argument name that indicates this fact. If the array is null and allowed to be so (like in the above example), the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the length of the array argument