Module com.github.cowwoc.requirements10.java

Package com.github.cowwoc.requirements10.java.validator

Interface ByteArrayValidator

All Superinterfaces:

ArrayComponent<ByteArrayValidator,Byte,byte[]>, ObjectComponent<ByteArrayValidator,byte[]>, ValidatorComponent<ByteArrayValidator,byte[]>

public interface ByteArrayValidator
extends ValidatorComponent<ByteArrayValidator,byte[]>, ObjectComponent<ByteArrayValidator,byte[]>, ArrayComponent<ByteArrayValidator,Byte,byte[]>

Validates the state of an byte[].

Method Summary

Modifier and Type	Method	Description
ByteArrayValidator	contains(byte expected)	Ensures that the array contains an element.
ByteArrayValidator	contains(byte expected, String name)	Ensures that the array contains an element.
ByteArrayValidator	doesNotContain(byte unwanted)	Ensures that the array does not contain unwanted.
ByteArrayValidator	doesNotContain(byte unwanted, String name)	Ensures that the array does not contain unwanted.
ByteArrayValidator	isSorted()	Ensures that the array is sorted by its natural ordering.

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ArrayComponent

contains, contains, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, containsExactly, containsExactly, containsExactly, containsExactly, doesNotContain, doesNotContain, doesNotContainAll, doesNotContainAll, doesNotContainAll, doesNotContainAll, doesNotContainAny, doesNotContainAny, doesNotContainAny, doesNotContainAny, doesNotContainDuplicates, doesNotContainExactly, doesNotContainExactly, doesNotContainExactly, doesNotContainExactly, isEmpty, isNotEmpty, isSorted, length

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ObjectComponent

getValue, isEqualTo, isEqualTo, isInstanceOf, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotInstanceOf, isNotInstanceOf, isNotNull, isNull, isReferenceEqualTo, isReferenceNotEqualTo

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ValidatorComponent

and, elseGetFailures, elseThrow, getContext, getContextAsString, getName, getValueOrDefault, validationFailed, withContext

Method Details

contains

ByteArrayValidator contains(byte expected)

Ensures that the array contains an element.

Parameters:

expected - the element

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the array does not contain expected

contains

ByteArrayValidator contains(byte expected,
 String name)

Ensures that the array contains an element.

Parameters:

expected - the element

name - the name of the element

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the array does not contain expected

doesNotContain

ByteArrayValidator doesNotContain(byte unwanted)

Ensures that the array does not contain unwanted.

Parameters:

unwanted - the unwanted element

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the array contains unwanted

doesNotContain

ByteArrayValidator doesNotContain(byte unwanted,
 String name)

Ensures that the array does not contain unwanted.

Parameters:

unwanted - the unwanted element

name - the name of the unwanted element

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the array contains unwanted

isSorted

ByteArrayValidator isSorted()

Ensures that the array is sorted by its natural ordering.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the array is not sorted

See Also:

• Comparator.naturalOrder()