JsonObjectValidationSet (org.spincast:spincast-framework 0.9.31 API)

All Superinterfaces:

ToJsonObjectConvertible, ValidationSet

All Known Subinterfaces:

JsonArrayValidationSet

All Known Implementing Classes:

JsonArrayValidationSetDefault, JsonObjectValidationSetDefault
```
public interface JsonObjectValidationSet
extends ValidationSet
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JsonObjectValidationBuilderKey`	`validation(SimpleValidator validator)` Starts a validation using a custom `SimpleValidator`.
`JsonObjectValidationBuilderKey`	`validationBlank()` Starts the creation of a "must be blank" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToBigDecimal()` Starts the creation of a "can be converted to a BigDecimal" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToBoolean()` Starts the creation of a "can be converted to a Boolean" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToByteArray()` Starts the creation of a "can be converted to a byte[]" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToDate()` Starts the creation of a "can be converted to a Date" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToDouble()` Starts the creation of a "can be converted to a Double" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToFloat()` Starts the creation of a "can be converted to a Float" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToInteger()` Starts the creation of a "can be converted to an Integer" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToJsonArray()` Starts the creation of a "can be converted to a JsonArray" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToJsonObject()` Starts the creation of a "can be converted to a JsonObject" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToLong()` Starts the creation of a "can be converted to a Long" validation.
`JsonObjectValidationBuilderKey`	`validationCanBeConvertedToString()` Starts the creation of a "can be converted to a String" validation.
`JsonObjectValidationBuilderKey`	`validationEmail()` Starts the creation of a "email" validation.
`JsonObjectValidationBuilderKey`	`validationEquivalent(Object reference)` Starts the creation of a "equivalent" validation.
`JsonObjectValidationBuilderKey`	`validationEquivalentOrGreater(Object reference)` Starts the creation of a "equivalent or greater" validation.
`JsonObjectValidationBuilderKey`	`validationEquivalentOrLess(Object reference)` Starts the creation of a "equivalent or less" validation.
`JsonObjectValidationBuilderKey`	`validationGreater(Object reference)` Starts the creation of a "greater than" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeBigDecimalOrNull()` Starts the creation of a "is of type BigDecimal or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeBooleanOrNull()` Starts the creation of a "is of type Boolean or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeByteArrayOrNull(boolean acceptBase64StringToo)` Starts the creation of a "is of type byte[] or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeDateOrNull()` Starts the creation of a "is of type Date or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeDoubleOrNull()` Starts the creation of a "is of type Double or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeFloatOrNull()` Starts the creation of a "is of type Float or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeIntegerOrNull()` Starts the creation of a "is of type Integer or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeJsonArrayOrNull()` Starts the creation of a "is of type JsonArray or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeJsonObjectOrNull()` Starts the creation of a "is of type JsonObject or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeLongOrNull()` Starts the creation of a "is of type Long or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeOrNull(Class<?> referenceType)` Starts the creation of a "is of type or null" validation.
`JsonObjectValidationBuilderKey`	`validationIsOfTypeStringOrNull()` Starts the creation of a "is of type String or null" validation.
`JsonObjectValidationBuilderKey`	`validationLength(int length)` Starts the creation of a "length" validation.
`JsonObjectValidationBuilderKey`	`validationLess(Object reference)` Starts the creation of a "less than" validation.
`JsonObjectValidationBuilderKey`	`validationMaxLength(int maxLength)` Starts the creation of a "maximum length" validation.
`JsonObjectValidationBuilderKey`	`validationMaxSize(int maxSize, boolean ignoreNullValues)` Starts the creation of a "maximum size" validation.
`JsonObjectValidationBuilderKey`	`validationMinLength(int minLength)` Starts the creation of a "minimum length" validation.
`JsonObjectValidationBuilderKey`	`validationMinSize(int minSize, boolean ignoreNullValues)` Starts the creation of a "minimum size" validation.
`JsonObjectValidationBuilderKey`	`validationNotBlank()` Starts the creation of a "not blank" validation.
`JsonObjectValidationBuilderKey`	`validationNotEquivalent(Object reference)` Starts the creation of a "not equivalent" validation.
`JsonObjectValidationBuilderKey`	`validationNotNull()` Starts the creation of a "not null" validation.
`JsonObjectValidationBuilderKey`	`validationNotPattern(String pattern)` Starts the creation of a "pattern must not match" validation.
`JsonObjectValidationBuilderKey`	`validationNull()` Starts the creation of a "must be null" validation.
`JsonObjectValidationBuilderKey`	`validationPattern(String pattern)` Starts the creation of a "pattern must match" validation.
`JsonObjectValidationBuilderKey`	`validationSize(int size, boolean ignoreNullValues)` Starts the creation of a "size" validation.

Methods inherited from interface org.spincast.core.validation.ValidationSet
addError, addMessage, addMessage, addSuccess, addWarning, convertToJsonObject, createValidationSet, getMessages, getMessages, getMessagesFormatted, getMessagesFormatted, hasMessages, hasMessages, isError, isError, isSuccess, isSuccess, isValid, isValid, isWarning, isWarning, mergeValidationSet, mergeValidationSet, prefixValidationKeys

- Method Detail
  - validation
```
JsonObjectValidationBuilderKey validation(SimpleValidator validator)
```
    Description copied from interface: ValidationSet
    
    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.
    
    Specified by:
    
    validation in interface ValidationSet
  - validationNotBlank
```
JsonObjectValidationBuilderKey validationNotBlank()
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "not blank" validation.
    
    Specified by:
    
    validationNotBlank in interface ValidationSet
  - validationBlank
```
JsonObjectValidationBuilderKey validationBlank()
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "must be blank" validation.
    
    Specified by:
    
    validationBlank in interface ValidationSet
  - validationEmail
```
JsonObjectValidationBuilderKey validationEmail()
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "email" validation.
    
    Specified by:
    
    validationEmail in interface ValidationSet
  - validationNull
```
JsonObjectValidationBuilderKey validationNull()
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "must be null" validation.
    
    Specified by:
    
    validationNull in interface ValidationSet
  - validationNotNull
```
JsonObjectValidationBuilderKey validationNotNull()
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "not null" validation.
    
    Specified by:
    
    validationNotNull in interface ValidationSet
  - validationPattern
```
JsonObjectValidationBuilderKey validationPattern(String pattern)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "pattern must match" validation.
    
    Specified by:
    
    validationPattern in interface ValidationSet
  - validationNotPattern
```
JsonObjectValidationBuilderKey validationNotPattern(String pattern)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "pattern must not match" validation.
    
    Specified by:
    
    validationNotPattern in interface ValidationSet
  - validationSize
```
JsonObjectValidationBuilderKey validationSize(int size,
                                              boolean ignoreNullValues)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "size" validation.
    
    Specified by:
    
    validationSize in interface ValidationSet
    
    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
```
JsonObjectValidationBuilderKey validationMinSize(int minSize,
                                                 boolean ignoreNullValues)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "minimum size" validation.
    
    Specified by:
    
    validationMinSize in interface ValidationSet
    
    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
```
JsonObjectValidationBuilderKey validationMaxSize(int maxSize,
                                                 boolean ignoreNullValues)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "maximum size" validation.
    
    Specified by:
    
    validationMaxSize in interface ValidationSet
    
    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
```
JsonObjectValidationBuilderKey validationLength(int length)
```
    Description copied from interface: ValidationSet
    
    Starts the creation of a "length" validation.
    
    Specified by:
    
    validationLength in interface ValidationSet
  - validationMinLength
```
JsonObjectValidationBuilderKey validationMinLength(int minLength)
```
    Description copied from interface: ValidationSet
    
    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".
    
    Specified by:
    
    validationMinLength in interface ValidationSet
  - validationMaxLength
```
JsonObjectValidationBuilderKey validationMaxLength(int maxLength)
```
    Description copied from interface: ValidationSet
    
    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".
    
    Specified by:
    
    validationMaxLength in interface ValidationSet
  - validationEquivalent
```
JsonObjectValidationBuilderKey validationEquivalent(Object reference)
```
    Description copied from interface: ValidationSet
    
    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).
    
    Specified by:
    
    validationEquivalent in interface ValidationSet
  - validationNotEquivalent
```
JsonObjectValidationBuilderKey validationNotEquivalent(Object reference)
```
    Description copied from interface: ValidationSet
    
    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).
    
    Specified by:
    
    validationNotEquivalent in interface ValidationSet
  - validationLess
```
JsonObjectValidationBuilderKey validationLess(Object reference)
```
    Description copied from interface: ValidationSet
    
    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.
    
    Specified by:
    
    validationLess in interface ValidationSet
  - validationGreater
```
JsonObjectValidationBuilderKey validationGreater(Object reference)
```
    Description copied from interface: ValidationSet
    
    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.
    
    Specified by:
    
    validationGreater in interface ValidationSet
  - validationEquivalentOrLess
```
JsonObjectValidationBuilderKey validationEquivalentOrLess(Object reference)
```
    Description copied from interface: ValidationSet
    
    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.
    
    Specified by:
    
    validationEquivalentOrLess in interface ValidationSet
  - validationEquivalentOrGreater
```
JsonObjectValidationBuilderKey validationEquivalentOrGreater(Object reference)
```
    Description copied from interface: ValidationSet
    
    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.
    
    Specified by:
    
    validationEquivalentOrGreater in interface ValidationSet
  - validationIsOfTypeOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeOrNull(Class<?> referenceType)
```
    Starts the creation of a "is of type or null" validation.
    
    Parameters:
    
    referenceType - the type to validate agains.
  - validationIsOfTypeStringOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeStringOrNull()
```
    Starts the creation of a "is of type String or null" validation.
  - validationIsOfTypeIntegerOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeIntegerOrNull()
```
    Starts the creation of a "is of type Integer or null" validation.
  - validationIsOfTypeLongOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeLongOrNull()
```
    Starts the creation of a "is of type Long or null" validation.
  - validationIsOfTypeFloatOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeFloatOrNull()
```
    Starts the creation of a "is of type Float or null" validation.
  - validationIsOfTypeDoubleOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeDoubleOrNull()
```
    Starts the creation of a "is of type Double or null" validation.
  - validationIsOfTypeBooleanOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeBooleanOrNull()
```
    Starts the creation of a "is of type Boolean or null" validation.
  - validationIsOfTypeBigDecimalOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeBigDecimalOrNull()
```
    Starts the creation of a "is of type BigDecimal or null" validation.
  - validationIsOfTypeByteArrayOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeByteArrayOrNull(boolean acceptBase64StringToo)
```
    Starts the creation of a "is of type byte[] or null" validation.
  - validationIsOfTypeDateOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeDateOrNull()
```
    Starts the creation of a "is of type Date or null" validation.
  - validationIsOfTypeJsonObjectOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeJsonObjectOrNull()
```
    Starts the creation of a "is of type JsonObject or null" validation.
  - validationIsOfTypeJsonArrayOrNull
```
JsonObjectValidationBuilderKey validationIsOfTypeJsonArrayOrNull()
```
    Starts the creation of a "is of type JsonArray or null" validation.
  - validationCanBeConvertedToString
```
JsonObjectValidationBuilderKey validationCanBeConvertedToString()
```
    Starts the creation of a "can be converted to a String" validation.
  - validationCanBeConvertedToInteger
```
JsonObjectValidationBuilderKey validationCanBeConvertedToInteger()
```
    Starts the creation of a "can be converted to an Integer" validation.
  - validationCanBeConvertedToLong
```
JsonObjectValidationBuilderKey validationCanBeConvertedToLong()
```
    Starts the creation of a "can be converted to a Long" validation.
  - validationCanBeConvertedToFloat
```
JsonObjectValidationBuilderKey validationCanBeConvertedToFloat()
```
    Starts the creation of a "can be converted to a Float" validation.
  - validationCanBeConvertedToBoolean
```
JsonObjectValidationBuilderKey validationCanBeConvertedToBoolean()
```
    Starts the creation of a "can be converted to a Boolean" validation.
  - validationCanBeConvertedToDate
```
JsonObjectValidationBuilderKey validationCanBeConvertedToDate()
```
    Starts the creation of a "can be converted to a Date" validation.
  - validationCanBeConvertedToDouble
```
JsonObjectValidationBuilderKey validationCanBeConvertedToDouble()
```
    Starts the creation of a "can be converted to a Double" validation.
  - validationCanBeConvertedToBigDecimal
```
JsonObjectValidationBuilderKey validationCanBeConvertedToBigDecimal()
```
    Starts the creation of a "can be converted to a BigDecimal" validation.
  - validationCanBeConvertedToByteArray
```
JsonObjectValidationBuilderKey validationCanBeConvertedToByteArray()
```
    Starts the creation of a "can be converted to a byte[]" validation.
  - validationCanBeConvertedToJsonObject
```
JsonObjectValidationBuilderKey validationCanBeConvertedToJsonObject()
```
    Starts the creation of a "can be converted to a JsonObject" validation.
  - validationCanBeConvertedToJsonArray
```
JsonObjectValidationBuilderKey validationCanBeConvertedToJsonArray()
```
    Starts the creation of a "can be converted to a JsonArray" validation.

Interface JsonObjectValidationSet

Field Summary

Fields inherited from interface org.spincast.core.validation.ValidationSet

Method Summary

Methods inherited from interface org.spincast.core.validation.ValidationSet

Method Detail

validation

validationNotBlank

validationBlank

validationEmail

validationNull

validationNotNull

validationPattern

validationNotPattern

validationSize

validationMinSize

validationMaxSize

validationLength

validationMinLength

validationMaxLength

validationEquivalent

validationNotEquivalent

validationLess

validationGreater

validationEquivalentOrLess

validationEquivalentOrGreater

validationIsOfTypeOrNull

validationIsOfTypeStringOrNull

validationIsOfTypeIntegerOrNull

validationIsOfTypeLongOrNull

validationIsOfTypeFloatOrNull

validationIsOfTypeDoubleOrNull

validationIsOfTypeBooleanOrNull

validationIsOfTypeBigDecimalOrNull

validationIsOfTypeByteArrayOrNull

validationIsOfTypeDateOrNull

validationIsOfTypeJsonObjectOrNull

validationIsOfTypeJsonArrayOrNull

validationCanBeConvertedToString

validationCanBeConvertedToInteger

validationCanBeConvertedToLong

validationCanBeConvertedToFloat

validationCanBeConvertedToBoolean

validationCanBeConvertedToDate

validationCanBeConvertedToDouble

validationCanBeConvertedToBigDecimal

validationCanBeConvertedToByteArray

validationCanBeConvertedToJsonObject

validationCanBeConvertedToJsonArray