org.bitbucket.cowwoc.requirements

Interface StringRequirements

All Superinterfaces:

Isolatable<StringRequirements>, ObjectRequirementsSpi<StringRequirements,String>

public interface StringRequirements
extends ObjectRequirementsSpi<StringRequirements,String>, Isolatable<StringRequirements>

Interface needed for Requirements.assertThat().

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
StringRequirements	doesNotEndWith(String suffix) Ensures that the parameter does not end with a value.
StringRequirements	doesNotStartWith(String prefix) Ensures that the parameter does not start with a value.
StringRequirements	endsWith(String suffix) Ensures that the parameter ends with a value.
StringRequirements	isEmailFormat() Ensures that the parameter contains a valid email format.
StringRequirements	isEmpty() Ensures that the parameter is empty.
StringRequirements	isIpAddressFormat() Ensures that the parameter contains a valid IP address format.
StringRequirements	isNotEmpty() Ensures that the parameter is not empty.
StringLengthRequirements	length()
StringRequirements	startsWith(String prefix) Ensures that the parameter starts with a value.
StringRequirements	trim() Trims whitespace at the beginning and end of the parameter.

Methods inherited from interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

isEqualTo, isEqualTo, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotNull, isNull, withContext, withException

Methods inherited from interface org.bitbucket.cowwoc.requirements.Isolatable

isolate

Method Detail

doesNotEndWith

StringRequirements doesNotEndWith(String suffix)
                           throws IllegalArgumentException

Ensures that the parameter does not end with a value.

Parameters:

suffix - the value the string must not end with

Returns:

this

Throws:

IllegalArgumentException - if the parameter ends with suffix

doesNotStartWith

StringRequirements doesNotStartWith(String prefix)
                             throws IllegalArgumentException

Ensures that the parameter does not start with a value.

Parameters:

prefix - the value the string must not start with

Returns:

this

Throws:

IllegalArgumentException - if the parameter starts with prefix

endsWith

StringRequirements endsWith(String suffix)
                     throws IllegalArgumentException

Ensures that the parameter ends with a value.

Parameters:

suffix - the value the string must end with

Returns:

this

Throws:

IllegalArgumentException - if the parameter does not end with suffix

isEmpty

StringRequirements isEmpty()
                    throws IllegalArgumentException

Ensures that the parameter is empty.

Returns:

this

Throws:

IllegalArgumentException - if the parameter is not empty

See Also:

trim()

isNotEmpty

StringRequirements isNotEmpty()
                       throws IllegalArgumentException

Ensures that the parameter is not empty.

Returns:

this

Throws:

IllegalArgumentException - if the parameter is empty

See Also:

trim()

isEmailFormat

StringRequirements isEmailFormat()
                          throws IllegalArgumentException

Ensures that the parameter contains a valid email format.

Returns:

this

Throws:

IllegalArgumentException - if the parameter does not contain a valid email format

isIpAddressFormat

StringRequirements isIpAddressFormat()
                              throws IllegalArgumentException

Ensures that the parameter contains a valid IP address format.

Returns:

this

Throws:

IllegalArgumentException - if the parameter does not contain a valid IP address format

startsWith

StringRequirements startsWith(String prefix)
                       throws IllegalArgumentException

Ensures that the parameter starts with a value.

Parameters:

prefix - the value the string must start with

Returns:

this

Throws:

IllegalArgumentException - if the parameter does not start with prefix

trim

StringRequirements trim()

Trims whitespace at the beginning and end of the parameter.

Returns:

this

length

StringLengthRequirements length()

Returns:

requirements over the String length