com.anaptecs.jeaf.xfun.api.checks

Interface Verifier

All Known Implementing Classes:

FallbackVerifierImpl

public interface Verifier

Interface defines all the methods that should be offered by verifier implementations. Verifiers provide check implementations that are used for checks and assertions. Check Assert

Method Summary

Modifier and Type	Method and Description
FailureMessage	hasEmptyIntersection(int pLowerBoundFirstSet, int pUpperBoundFirstSet, int pLowerBoundSecondSet, int pUpperBoundSecondSet) Method verifies whether the first and the second set have a empty intersection.
FailureMessage	hasIntersection(int pLowerBoundFirstSet, int pUpperBoundFirstSet, int pLowerBoundSecondSet, int pUpperBoundSecondSet) Method verifies whether the first and the second set have a not null intersection.
FailureMessage	isFalse(boolean pCondition, String pDescription) Method verifies if the passed condition is false.
FailureMessage	isNotNull(Object pObject, String pObjectName) Method verifies whether the passed object is null or not.
FailureMessage	isNotPartOfSet(int pLowerBound, int pUpperBound, int pValue) Method verifies whether the passed value is not part of the passed set.
FailureMessage	isNull(Object pObject, String pObjectName) Method verifies that the passed object is null.
FailureMessage	isPartOfSet(int pLowerBound, int pUpperBound, int pValue) Method verifies whether the passed value is part of the passed set.
FailureMessage	isRealString(String pString, String pStringName) Method verifies whether the passed string is a real string.
FailureMessage	isSubset(int pLowerBoundSet, int pUpperBoundSet, int pLowerBoundSubset, int pUpperBoundSubset) Method verifies whether the passed set is a subset.
FailureMessage	isTrue(boolean pCondition, String pDescription) Method verifies if the passed condition is true.
FailureMessage	isValidSet(int pLowerBound, int pUpperBound) Method verifies whether the passed parameters define a valid set.
FailureMessage	isZeroOrGreater(int pValue, String pValueName) Method verifies whether the passed parameter is is zero or greater or not.
FailureMessage	verifyEMailAddress(String pEMailAddress) Method verifies if the passed string represents a valid email address.
FailureMessage	verifyMaximumCollectionSize(Collection<?> pCollection, int pMaximumSize) Method verifies whether the passed collection has the passed minimum size.
FailureMessage	verifyMaxStringLength(String pString, int pMaxLenght, String pStringName) Method verifies whether the passed string is not longer than the passed maximum length.
FailureMessage	verifyMinimumCollectionSize(Collection<?> pCollection, int pMinimumSize) Method verifies whether the passed collection has the passed minimum size.
FailureMessage	verifyPattern(String pCharacters, String pPattern) Method verifies whether the passed character sequence matches with the passed pattern.
FailureMessage	verifyValidPeriod(Date pStart, Date pEnd) Method verifies whether the passed start and end dates define a valid period.

Method Detail

isNotNull

FailureMessage isNotNull(Object pObject,
                         String pObjectName)

Method verifies whether the passed object is null or not.

Parameters:

pObject - Object that should be checked for null. If pObject is null an error is indicated.

pObjectName - Name of the object that is checked for null. The parameter may be null.

Returns:

VerificationFailure Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all error cases the method returns a VerificationFailure object.

isZeroOrGreater

FailureMessage isZeroOrGreater(int pValue,
                               String pValueName)

Method verifies whether the passed parameter is is zero or greater or not.

Parameters:

pValue - Value that should be check if it is zero or greater.

pValueName - Name of the value that is checked. The parameter may be null.

Returns:

VerificationFailure Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a VerificationFailure object.

isNull

FailureMessage isNull(Object pObject,
                      String pObjectName)

Method verifies that the passed object is null.

Parameters:

pObject - Object that should be checked for null. If pObject is not null an error is indicated.

pObjectName - Name of the object that is checked for null. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all error cases the method returns a FailureMessage object.

isTrue

FailureMessage isTrue(boolean pCondition,
                      String pDescription)

Method verifies if the passed condition is true.

Parameters:

pCondition - Condition that should be check if it is true.

pDescription - Description of the condition. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all error cases the method returns a FailureMessage object.

isFalse

FailureMessage isFalse(boolean pCondition,
                       String pDescription)

Method verifies if the passed condition is false.

Parameters:

pCondition - Condition that should be check if it is false.

pDescription - Description of the condition. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all error cases the method returns a FailureMessage object.

isRealString

FailureMessage isRealString(String pString,
                            String pStringName)

Method verifies whether the passed string is a real string. A String object is a "real" string whenever it is not null and its trimmed version consists of at least one character.

Parameters:

pString - String object that should be checked if it is a real string. If pString is null an error is indicated.

pStringName - Name of the string that is checked. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyMaxStringLength

FailureMessage verifyMaxStringLength(String pString,
                                     int pMaxLenght,
                                     String pStringName)

Method verifies whether the passed string is not longer than the passed maximum length.

Parameters:

pString - String object that should be checked for its length. The parameter must not be null.

pMaxLenght - Maximum length the string may have.

pStringName - Name of the string that is checked. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

isValidSet

FailureMessage isValidSet(int pLowerBound,
                          int pUpperBound)

Method verifies whether the passed parameters define a valid set. A set is valid if the lower bound is less or equal to the upper bound. In all other cases the verification fails.

Parameters:

pLowerBound - Lower bound of the set.

pUpperBound - Upper bound of the set.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

isPartOfSet

FailureMessage isPartOfSet(int pLowerBound,
                           int pUpperBound,
                           int pValue)

Method verifies whether the passed value is part of the passed set. The verification fails if the passed value is not within the passed set or if the lower and upper bound do not define a valid set.

Parameters:

pLowerBound - Lower bound of the set. The parameter must define a valid set together with pUpperBound.

pUpperBound - Upper bound of the set. The parameter must define a valid set together with pLowerBound.

pValue - Value for which is verified if it is part of the defined set.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

isNotPartOfSet

FailureMessage isNotPartOfSet(int pLowerBound,
                              int pUpperBound,
                              int pValue)

Method verifies whether the passed value is not part of the passed set. The verification fails if the passed value is within the passed set or if the lower and upper bound do not define a valid set.

Parameters:

pLowerBound - Lower bound of the set. The parameter must define a valid set together with pUpperBound.

pUpperBound - Upper bound of the set. The parameter must define a valid set together with pLowerBound.

pValue - Value for which is verified if it is not part of the defined set.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

isSubset

FailureMessage isSubset(int pLowerBoundSet,
                        int pUpperBoundSet,
                        int pLowerBoundSubset,
                        int pUpperBoundSubset)

Method verifies whether the passed set is a subset. The verification fails if the passed values are not a subset of the passed set or if the the passed values do not define valid sets.

Parameters:

pLowerBoundSet - Lower bound of the set. The parameter must define a valid set together with pUpperBoundSet.

pUpperBoundSet - Upper bound of the set. The parameter must define a valid set together with pLowerBoundSet.

pLowerBoundSubset - Lower bound of the subset. The parameter must define a valid set together with pUpperBoundSubset.

pUpperBoundSubset - Upper bound of the subset. The parameter must define a valid set together with pLowerBoundSubset.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

hasIntersection

FailureMessage hasIntersection(int pLowerBoundFirstSet,
                               int pUpperBoundFirstSet,
                               int pLowerBoundSecondSet,
                               int pUpperBoundSecondSet)

Method verifies whether the first and the second set have a not null intersection. The verification fails if the two sets do not have a not null intersection or if one of the sets is not a valid set.

Parameters:

pLowerBoundFirstSet - Lower bound of the first set. The parameter must define a valid set together with pUpperBoundFirstSet.

pUpperBoundFirstSet - Upper bound of the first set. The parameter must define a valid set together with pLowerBoundFirstSet.

pLowerBoundSecondSet - Lower bound of the second set. The parameter must define a valid set together with pUpperBoundSecondSet.

pUpperBoundSecondSet - Upper bound of the second set. The parameter must define a valid set together with pLowerBoundSecondSet.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

hasEmptyIntersection

FailureMessage hasEmptyIntersection(int pLowerBoundFirstSet,
                                    int pUpperBoundFirstSet,
                                    int pLowerBoundSecondSet,
                                    int pUpperBoundSecondSet)

Method verifies whether the first and the second set have a empty intersection. The verification fails if the two sets do not have a empty intersection or if one of the sets is not a valid set.

Parameters:

pLowerBoundFirstSet - Lower bound of the first set. The parameter must define a valid set together with pUpperBoundFirstSet.

pUpperBoundFirstSet - Upper bound of the first set. The parameter must define a valid set together with pLowerBoundFirstSet.

pLowerBoundSecondSet - Lower bound of the second set. The parameter must define a valid set together with pUpperBoundSecondSet.

pUpperBoundSecondSet - Upper bound of the second set. The parameter must define a valid set together with pLowerBoundSecondSet.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyPattern

FailureMessage verifyPattern(String pCharacters,
                             String pPattern)

Method verifies whether the passed character sequence matches with the passed pattern.

Parameters:

pCharacters - Character sequence to verify. The parameter must not be null.

pPattern - Regular expression pattern which will be used to verify the passed character sequence. The parameter must not be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyMinimumCollectionSize

FailureMessage verifyMinimumCollectionSize(Collection<?> pCollection,
                                           int pMinimumSize)

Method verifies whether the passed collection has the passed minimum size.

Parameters:

pCollection - Collection that should be verified for its minimum size. The parameter must not be null.

pMinimumSize - Minimum size the passed collection must have. The amount of elements within the collection must be equal or greater than this value.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyMaximumCollectionSize

FailureMessage verifyMaximumCollectionSize(Collection<?> pCollection,
                                           int pMaximumSize)

Method verifies whether the passed collection has the passed minimum size.

Parameters:

pCollection - Collection that should be verified for its maximum size. The parameter must not be null.

pMaximumSize - Maximum size the passed collection must have. The amount of elements within the collection must be less or equal than this value.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyValidPeriod

FailureMessage verifyValidPeriod(Date pStart,
                                 Date pEnd)

Method verifies whether the passed start and end dates define a valid period. The verification is fulfilled if the start date is before the end date.

Parameters:

pStart - Start of the period. The parameter may be null.

pEnd - End of the period. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.

verifyEMailAddress

FailureMessage verifyEMailAddress(String pEMailAddress)

Method verifies if the passed string represents a valid email address.

Parameters:

pEMailAddress - Representation of the email address. The parameter may be null.

Returns:

FailureMessage Verification failure describing the reason why the verification failed. If no error occurred the method returns null. In all other cases the method returns a FailureMessage object.