ValidationSet (org.spincast:spincast-framework 0.9.29 API)

All Superinterfaces:

ToJsonObjectConvertible

All Known Subinterfaces:

JsonArrayValidationSet, JsonObjectValidationSet

All Known Implementing Classes:

JsonArrayValidationSetDefault, JsonObjectValidationSetDefault, ValidationSetDefault
```
public interface ValidationSet
extends ToJsonObjectConvertible
```
A validation set is a container to store one or multiple validation messages. It represents the result of a validation of a particular element, or of a group of elements.
You create a validation set then you add some validation Messages to it, manually using the addMessage similar methods, or by using some provided validators, such as validationNotBlank().
Multiple validation sets can be grouped together using the mergeValidationSet(ValidationSet) related methods. This means you can validate some elements independently, then group the results together to form a final validation set.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`VALIDATION_CODE_BLANK`
`static String`	`VALIDATION_CODE_CAN_BE_CONVERTED_TO`
`static String`	`VALIDATION_CODE_EMAIL`
`static String`	`VALIDATION_CODE_EQUIVALENT`
`static String`	`VALIDATION_CODE_EQUIVALENT_OR_GREATER`
`static String`	`VALIDATION_CODE_EQUIVALENT_OR_LESS`
`static String`	`VALIDATION_CODE_GREATER`
`static String`	`VALIDATION_CODE_IS_OF_TYPE`
`static String`	`VALIDATION_CODE_LENGTH`
`static String`	`VALIDATION_CODE_LESS`
`static String`	`VALIDATION_CODE_MAX_LENGTH`
`static String`	`VALIDATION_CODE_MAX_SIZE`
`static String`	`VALIDATION_CODE_MIN_LENGTH`
`static String`	`VALIDATION_CODE_MIN_SIZE`
`static String`	`VALIDATION_CODE_NOT_AN_ARRAY`
`static String`	`VALIDATION_CODE_NOT_BLANK`
`static String`	`VALIDATION_CODE_NOT_EQUIVALENT`
`static String`	`VALIDATION_CODE_NOT_NULL`
`static String`	`VALIDATION_CODE_NOT_PATTERN`
`static String`	`VALIDATION_CODE_NULL`
`static String`	`VALIDATION_CODE_PATTERN`
`static String`	`VALIDATION_CODE_SIZE`
`static String`	`VALIDATION_CODE_WHOLE_ARRAY_VALIDATION_RESULT_TYPE` Codes for some provided validations :

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ValidationSet`	`addError(String validationKey, String code, String text)` Creates and adds a new Error validation Message.
`ValidationSet`	`addMessage(String validationKey, ValidationLevel messageLevel, String code, String text)` Creates and adds a new validation Message.
`ValidationSet`	`addMessage(String validationKey, ValidationMessage validationMessage)` Adds a new validation Message to this set, using the specified validation key.
`ValidationSet`	`addSuccess(String validationKey, String code, String text)` Creates and adds a new Success validation Message.
`ValidationSet`	`addWarning(String validationKey, String code, String text)` Creates and adds a new Warning validation Message.
`JsonObject`	`convertToJsonObject()` Converts the set to a `JsonObject` object.
`ValidationSet`	`createValidationSet()` Creates a new, empty, validation set.
`Map<String,List<ValidationMessage>>`	`getMessages()` Gets the validation keys and their associated messages.
`List<ValidationMessage>`	`getMessages(String validationKey)` Gets the validation messages for the specified key.
`String`	`getMessagesFormatted(String validationKey, ValidationMessageFormatType formatType)` Quick way to get a formatted version of the validation messages for the specified key.
`String`	`getMessagesFormatted(ValidationMessageFormatType formatType)` Quick way to get a formatted version of all validation messages.
`boolean`	`hasMessages()` Does this validation set contain any validation Messages?
`boolean`	`hasMessages(String validationKey)` Does the the element at the specified key contains validation Messages?
`boolean`	`isError()` Returns `true` if the validation set contains at least one ERROR message.
`boolean`	`isError(String validationKey)` Returns `true` if the validation set for the element at the specified key contains at least one ERROR message.
`boolean`	`isSuccess()` Returns `true` if the validation set only contains SUCCESS messages (or contains no messages at all).
`boolean`	`isSuccess(String validationKey)` Returns `true` if the validation set for the element at the specified key only contains SUCCESS messages (or contains no messages at all).
`boolean`	`isValid()` Returns `true` if the validation set does not contain ERROR messages.
`boolean`	`isValid(String validationKey)` Returns `true` if the validation set for the element at the specified key does not contain ERROR messages.
`boolean`	`isWarning()` Returns `true` if the validation set contains at least one WARNING message, but no ERROR messages.
`boolean`	`isWarning(String validationKey)` Returns `true` if the validation set for the element at the specified key contains at least one WARNING message, but no ERROR messages.
`ValidationSet`	`mergeValidationSet(String validationKeyPrefix, ValidationSet result)` Adds an existing validation set and prefix all the validation keys of this Set using the `validationKeyPrefix`.
`ValidationSet`	`mergeValidationSet(ValidationSet set)` Merges an existing validation set.
`ValidationSet`	`prefixValidationKeys(String prefix)` Prefix all the currently existing validation keys in this Set with the specified prefix.
`ValidationBuilderKey`	`validation(SimpleValidator validator)` Starts a validation using a custom `SimpleValidator`.
`ValidationBuilderKey`	`validationBlank()` Starts the creation of a "must be blank" validation.
`ValidationBuilderKey`	`validationEmail()` Starts the creation of a "email" validation.
`ValidationBuilderKey`	`validationEquivalent(Object reference)` Starts the creation of a "equivalent" validation.
`ValidationBuilderKey`	`validationEquivalentOrGreater(Object reference)` Starts the creation of a "equivalent or greater" validation.
`ValidationBuilderKey`	`validationEquivalentOrLess(Object reference)` Starts the creation of a "equivalent or less" validation.
`ValidationBuilderKey`	`validationGreater(Object reference)` Starts the creation of a "greater than" validation.
`ValidationBuilderKey`	`validationLength(int length)` Starts the creation of a "length" validation.
`ValidationBuilderKey`	`validationLess(Object reference)` Starts the creation of a "less than" validation.
`ValidationBuilderKey`	`validationMaxLength(int maxLength)` Starts the creation of a "maximum length" validation.
`ValidationBuilderKey`	`validationMaxSize(int maxSize, boolean ignoreNullValues)` Starts the creation of a "maximum size" validation.
`ValidationBuilderKey`	`validationMinLength(int minLength)` Starts the creation of a "minimum length" validation.
`ValidationBuilderKey`	`validationMinSize(int minSize, boolean ignoreNullValues)` Starts the creation of a "minimum size" validation.
`ValidationBuilderKey`	`validationNotBlank()` Starts the creation of a "not blank" validation.
`ValidationBuilderKey`	`validationNotEquivalent(Object reference)` Starts the creation of a "not equivalent" validation.
`ValidationBuilderKey`	`validationNotNull()` Starts the creation of a "not null" validation.
`ValidationBuilderKey`	`validationNotPattern(String pattern)` Starts the creation of a "pattern must not match" validation.
`ValidationBuilderKey`	`validationNull()` Starts the creation of a "must be null" validation.
`ValidationBuilderKey`	`validationPattern(String pattern)` Starts the creation of a "pattern must match" validation.
`ValidationBuilderKey`	`validationSize(int size, boolean ignoreNullValues)` Starts the creation of a "size" validation.

- Field Detail
  - VALIDATION_CODE_WHOLE_ARRAY_VALIDATION_RESULT_TYPE
```
static final String VALIDATION_CODE_WHOLE_ARRAY_VALIDATION_RESULT_TYPE
```
    Codes for some provided validations :
    
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NOT_AN_ARRAY
```
static final String VALIDATION_CODE_NOT_AN_ARRAY
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NOT_NULL
```
static final String VALIDATION_CODE_NOT_NULL
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NULL
```
static final String VALIDATION_CODE_NULL
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NOT_BLANK
```
static final String VALIDATION_CODE_NOT_BLANK
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_BLANK
```
static final String VALIDATION_CODE_BLANK
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_EQUIVALENT
```
static final String VALIDATION_CODE_EQUIVALENT
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NOT_EQUIVALENT
```
static final String VALIDATION_CODE_NOT_EQUIVALENT
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_EQUIVALENT_OR_GREATER
```
static final String VALIDATION_CODE_EQUIVALENT_OR_GREATER
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_GREATER
```
static final String VALIDATION_CODE_GREATER
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_EQUIVALENT_OR_LESS
```
static final String VALIDATION_CODE_EQUIVALENT_OR_LESS
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_LESS
```
static final String VALIDATION_CODE_LESS
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_LENGTH
```
static final String VALIDATION_CODE_LENGTH
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_MIN_LENGTH
```
static final String VALIDATION_CODE_MIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_MAX_LENGTH
```
static final String VALIDATION_CODE_MAX_LENGTH
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_PATTERN
```
static final String VALIDATION_CODE_PATTERN
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_NOT_PATTERN
```
static final String VALIDATION_CODE_NOT_PATTERN
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_EMAIL
```
static final String VALIDATION_CODE_EMAIL
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_SIZE
```
static final String VALIDATION_CODE_SIZE
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_MIN_SIZE
```
static final String VALIDATION_CODE_MIN_SIZE
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_MAX_SIZE
```
static final String VALIDATION_CODE_MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_CAN_BE_CONVERTED_TO
```
static final String VALIDATION_CODE_CAN_BE_CONVERTED_TO
```
    See Also:
    
    Constant Field Values
  - VALIDATION_CODE_IS_OF_TYPE
```
static final String VALIDATION_CODE_IS_OF_TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createValidationSet
```
ValidationSet createValidationSet()
```
    Creates a new, empty, validation set.
  - addMessage
```
ValidationSet addMessage(String validationKey,
                         ValidationMessage validationMessage)
```
    Adds a new validation Message to this set, using the specified validation key.
    
    Returns:
    
    itself (fluent style)
  - addMessage
```
ValidationSet addMessage(String validationKey,
                         ValidationLevel messageLevel,
                         String code,
                         String text)
```
    Creates and adds a new validation Message.
    
    Returns:
    
    itself (fluent style)
  - addError
```
ValidationSet addError(String validationKey,
                       String code,
                       String text)
```
    Creates and adds a new Error validation Message.
    
    Returns:
    
    itself (fluent style)
  - addWarning
```
ValidationSet addWarning(String validationKey,
                         String code,
                         String text)
```
    Creates and adds a new Warning validation Message.
    
    Returns:
    
    itself (fluent style)
  - addSuccess
```
ValidationSet addSuccess(String validationKey,
                         String code,
                         String text)
```
    Creates and adds a new Success validation Message.
    
    Returns:
    
    itself (fluent style)
  - mergeValidationSet
```
ValidationSet mergeValidationSet(ValidationSet set)
```
    Merges an existing validation set.
    
    Returns:
    
    itself (fluent style)
  - mergeValidationSet
```
ValidationSet mergeValidationSet(String validationKeyPrefix,
                                 ValidationSet result)
```
    Adds an existing validation set and prefix all the validation keys of this Set using the validationKeyPrefix.
    
    Returns:
    
    itself (fluent style)
  - hasMessages
```
boolean hasMessages()
```
    Does this validation set contain any validation Messages?
  - hasMessages
```
boolean hasMessages(String validationKey)
```
    Does the the element at the specified key contains validation Messages?
  - isWarning
```
boolean isWarning()
```
    Returns true if the validation set contains at least one WARNING message, but no ERROR messages.
  - isWarning
```
boolean isWarning(String validationKey)
```
    Returns true if the validation set for the element at the specified key contains at least one WARNING message, but no ERROR messages.
  - isSuccess
```
boolean isSuccess()
```
    Returns true if the validation set only contains SUCCESS messages (or contains no messages at all).
  - isSuccess
```
boolean isSuccess(String validationKey)
```
    Returns true if the validation set for the element at the specified key only contains SUCCESS messages (or contains no messages at all).
  - isError
```
boolean isError()
```
    Returns true if the validation set contains at least one ERROR message.
  - isError
```
boolean isError(String validationKey)
```
    Returns true if the validation set for the element at the specified key contains at least one ERROR message.
  - isValid
```
boolean isValid()
```
    Returns true if the validation set does not contain ERROR messages. The set may contain WARNING messages.
    This is a synonym of !isError().
  - isValid
```
boolean isValid(String validationKey)
```
    Returns true if the validation set for the element at the specified key does not contain ERROR messages. The element may contains WARNING messages.
    This is a synonym of !isError(key).
  - getMessages
```
Map<String,List<ValidationMessage>> getMessages()
```
    Gets the validation keys and their associated messages.
    The Map and the lists are immutable.
  - getMessages
```
List<ValidationMessage> getMessages(String validationKey)
```
    Gets the validation messages for the specified key.
    The list is immutable.
  - getMessagesFormatted
```
String getMessagesFormatted(String validationKey,
                            ValidationMessageFormatType formatType)
```
    Quick way to get a formatted version of the validation messages for the specified key.
    
    Parameters:
    
    key - The key to get messages for.
    
    formatType - The type of output for the messages (Text, HTML, Json or XML).
    
    Returns:
    
    the formatted messages or null if there are no validation messages.
  - getMessagesFormatted
```
String getMessagesFormatted(ValidationMessageFormatType formatType)
```
    Quick way to get a formatted version of all validation messages.
    
    Parameters:
    
    formatType - The type of output for the messages (Text, HTML, Json or XML).
    
    Returns:
    
    the formatted messages or null if there are no validation messages.
  - convertToJsonObject
```
JsonObject convertToJsonObject()
```
    Converts the set to a JsonObject object.
    The resulting JsonObject object is immutable.
    
    Specified by:
    
    convertToJsonObject in interface ToJsonObjectConvertible
  - validation
```
ValidationBuilderKey validation(SimpleValidator validator)
```
    Starts a validation using a custom SimpleValidator.
    This is useful when you have a validator that can be reuse in different contexts (as the ones provided by Spincast).
    If you need full control over a validation, the number of generated Messages for example, then you can instead run your validations as you wish and use #addMessage(ValidationMessage) and other similar methods to add the resulting validation Messages to the set.
  - validationNotBlank
```
ValidationBuilderKey validationNotBlank()
```
    Starts the creation of a "not blank" validation.
  - validationBlank
```
ValidationBuilderKey validationBlank()
```
    Starts the creation of a "must be blank" validation.
  - validationEmail
```
ValidationBuilderKey validationEmail()
```
    Starts the creation of a "email" validation.
  - validationNotNull
```
ValidationBuilderKey validationNotNull()
```
    Starts the creation of a "not null" validation.
  - validationNull
```
ValidationBuilderKey validationNull()
```
    Starts the creation of a "must be null" validation.
  - validationPattern
```
ValidationBuilderKey validationPattern(String pattern)
```
    Starts the creation of a "pattern must match" validation.
  - validationNotPattern
```
ValidationBuilderKey validationNotPattern(String pattern)
```
    Starts the creation of a "pattern must not match" validation.
  - validationSize
```
ValidationBuilderKey validationSize(int size,
                                    boolean ignoreNullValues)
```
    Starts the creation of a "size" validation.
    
    Parameters:
    
    ignoreNullValues - If true, null values will be ignored in the total count. For example, if the size validation is done on a JsonArray which is [null, null "abc"], the size would be 3 if ignoreNullValues is false and 1 if it's true.
  - validationMinSize
```
ValidationBuilderKey validationMinSize(int minSize,
                                       boolean ignoreNullValues)
```
    Starts the creation of a "minimum size" validation.
    
    Parameters:
    
    ignoreNullValues - If true, null values will be ignored in the total count. For example, if the size validation is done on a JsonArray which is [null, null "abc"], the size would be 3 if ignoreNullValues is false and 1 if it's true.
  - validationMaxSize
```
ValidationBuilderKey validationMaxSize(int maxSize,
                                       boolean ignoreNullValues)
```
    Starts the creation of a "maximum size" validation.
    
    Parameters:
    
    ignoreNullValues - If true, null values will be ignored in the total count. For example, if the size validation is done on a JsonArray which is [null, null "abc"], the size would be 3 if ignoreNullValues is false and 1 if it's true.
  - validationLength
```
ValidationBuilderKey validationLength(int length)
```
    Starts the creation of a "length" validation.
  - validationMinLength
```
ValidationBuilderKey validationMinLength(int minLength)
```
    Starts the creation of a "minimum length" validation.
    A null value returns false, otherwise toString() is called on the other object to check its "length".
  - validationMaxLength
```
ValidationBuilderKey validationMaxLength(int maxLength)
```
    Starts the creation of a "maximum length" validation.
    A null value returns true, otherwise toString() is called on the other object to check its "length".
  - validationEquivalent
```
ValidationBuilderKey validationEquivalent(Object reference)
```
    Starts the creation of a "equivalent" validation.
    To validate if an element is equivalent to another, one is converted to the type of the other if this is required. If this conversion fails, they are not equivalent. When both elements are of the same types, the #equals(Object) method is used to compre them.
    The exact logic to determine if two elements are equivalent can be found in ObjectConverter.isEquivalent(Object, Object).
  - validationNotEquivalent
```
ValidationBuilderKey validationNotEquivalent(Object reference)
```
    Starts the creation of a "not equivalent" validation.
    To validate if an element is equivalent to another, one is converted to the type of the other if this is required. If this conversion fails, they are not equivalent. When both elements are of the same types, the #equals(Object) method is used to compre them.
    The exact logic to determine if two elements are equivalent can be found in ObjectConverter.isEquivalent(Object, Object).
  - validationLess
```
ValidationBuilderKey validationLess(Object reference)
                             throws CantCompareException
```
    Starts the creation of a "less than" validation.
    To validate if an element is less than another, one is converted to the type of the other if this is required. If this conversion fails, they can't be compared. The resulting type must implement the Comparable interface, so the Comparable.compareTo(Object) method is used to compare the two elements.
    null is always less than a non-null element.
    
    Throws:
    
    CantCompareException - if the two elements can't be compared together.
  - validationGreater
```
ValidationBuilderKey validationGreater(Object reference)
                                throws CantCompareException
```
    Starts the creation of a "greater than" validation.
    To validate if an element is greater than another, one is converted to the type of the other if this is required. If this conversion fails, they can't be compared. The resulting type must implement the Comparable interface, so the Comparable.compareTo(Object) method is used to compare the two elements.
    null is always less than a non-null element.
    
    Throws:
    
    CantCompareException - if the two elements can't be compared together.
  - validationEquivalentOrLess
```
ValidationBuilderKey validationEquivalentOrLess(Object reference)
                                         throws CantCompareException
```
    Starts the creation of a "equivalent or less" validation.
    To validate if an element is equivalent or less than another, one is converted to the type of the other if this is required. If this conversion fails, they can't be compared. The resulting type must implement the Comparable interface, so the Comparable.compareTo(Object) method is used to compare the two elements.
    null is always less than a non-null element.
    
    Throws:
    
    CantCompareException - if the two elements can't be compared together.
  - validationEquivalentOrGreater
```
ValidationBuilderKey validationEquivalentOrGreater(Object reference)
                                            throws CantCompareException
```
    Starts the creation of a "equivalent or greater" validation.
    To validate if an element is equivalent or greater than another, one is converted to the type of the other if this is required. If this conversion fails, they can't be compared. The resulting type must implement the Comparable interface, so the Comparable.compareTo(Object) method is used to compare the two elements.
    null is always less than a non-null element.
    
    Throws:
    
    CantCompareException - if the two elements can't be compared together.
  - prefixValidationKeys
```
ValidationSet prefixValidationKeys(String prefix)
```
    Prefix all the currently existing validation keys in this Set with the specified prefix.
    
    Returns:
    
    itself (fluent style)

Interface ValidationSet

Field Summary

Method Summary

Field Detail

VALIDATION_CODE_WHOLE_ARRAY_VALIDATION_RESULT_TYPE

VALIDATION_CODE_NOT_AN_ARRAY

VALIDATION_CODE_NOT_NULL

VALIDATION_CODE_NULL

VALIDATION_CODE_NOT_BLANK

VALIDATION_CODE_BLANK

VALIDATION_CODE_EQUIVALENT

VALIDATION_CODE_NOT_EQUIVALENT

VALIDATION_CODE_EQUIVALENT_OR_GREATER

VALIDATION_CODE_GREATER

VALIDATION_CODE_EQUIVALENT_OR_LESS

VALIDATION_CODE_LESS

VALIDATION_CODE_LENGTH

VALIDATION_CODE_MIN_LENGTH

VALIDATION_CODE_MAX_LENGTH

VALIDATION_CODE_PATTERN

VALIDATION_CODE_NOT_PATTERN

VALIDATION_CODE_EMAIL

VALIDATION_CODE_SIZE

VALIDATION_CODE_MIN_SIZE

VALIDATION_CODE_MAX_SIZE

VALIDATION_CODE_CAN_BE_CONVERTED_TO

VALIDATION_CODE_IS_OF_TYPE

Method Detail

createValidationSet

addMessage

addMessage

addError

addWarning

addSuccess

mergeValidationSet

mergeValidationSet

hasMessages

hasMessages

isWarning

isWarning

isSuccess

isSuccess

isError

isError

isValid

isValid

getMessages

getMessages

getMessagesFormatted

getMessagesFormatted

convertToJsonObject

validation

validationNotBlank

validationBlank

validationEmail

validationNotNull

validationNull

validationPattern

validationNotPattern

validationSize

validationMinSize

validationMaxSize

validationLength

validationMinLength

validationMaxLength

validationEquivalent

validationNotEquivalent

validationLess

validationGreater

validationEquivalentOrLess

validationEquivalentOrGreater

prefixValidationKeys