public.javadoc.org.spincast.core.validation.ValidationSet.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







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











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.core.validation
Interface ValidationSet






All Known Subinterfaces:
Form


All Known Implementing Classes:
FormDefault, ValidationSetSimple




public interface ValidationSet











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
addError(String validationKey,
        String code,
        String text)
Creates and adds a new Error validation Message.



void
addError(String validationKey,
        String code,
        String text,
        ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Error validation Message.



void
addMessage(String validationKey,
          ValidationLevel messageLevel,
          String code,
          String text)
Creates and adds a new validation Message.



void
addMessage(String validationKey,
          ValidationLevel messageLevel,
          String code,
          String text,
          ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new validation Message.



void
addMessage(String validationKey,
          ValidationMessage validationMessage)
Adds a new validation Message to this set, using the
 specified validation key.



void
addSuccess(String validationKey,
          String code,
          String text)
Creates and adds a new Success validation Message.



void
addSuccess(String validationKey,
          String code,
          String text,
          ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Success validation Message.



void
addWarning(String validationKey,
          String code,
          String text)
Creates and adds a new Warning validation Message.)



void
addWarning(String validationKey,
          String code,
          String text,
          ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Warning validation Message.)



ValidationSet
createNewValidationSet()
Creates a new ValidationSet.



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.



JsonObject
getValidationResultAsJsonObject()
The JsonObject in which the validation messages
 are actually stored.



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 elements at the specified keys
 dont 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 validationSet)
Merges another ValidationSet and prefixes all the
 validation keys of this set using the
 validationKeyPrefix.



ValidationSet
mergeValidationSet(ValidationSet validationSet)
Merges another ValidationSet.



int
size()
The number of validation messages in this set.
















Method Detail





addMessage
void addMessage(String validationKey,
                ValidationMessage validationMessage)
Adds a new validation Message to this set, using the
 specified validation key.







addMessage
void addMessage(String validationKey,
                ValidationLevel messageLevel,
                String code,
                String text)
Creates and adds a new validation Message.
 
 Escapes the message in <pre> 
 tags if displayed in HTML.







addMessage
void addMessage(String validationKey,
                ValidationLevel messageLevel,
                String code,
                String text,
                ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new validation Message.

Parameters:
htmlEscape - if this message if displayed using 
 HTML, how should it be escaped?








addError
void addError(String validationKey,
              String code,
              String text)
Creates and adds a new Error validation Message.
 
 Escapes the message in <pre> 
 tags if displayed in HTML.







addError
void addError(String validationKey,
              String code,
              String text,
              ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Error validation Message.

Parameters:
htmlEscape - if this message if displayed using 
 HTML, should should it be escaped?








addWarning
void addWarning(String validationKey,
                String code,
                String text)
Creates and adds a new Warning validation Message.)
 
 Escapes the message in <pre> 
 tags if displayed in HTML.







addWarning
void addWarning(String validationKey,
                String code,
                String text,
                ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Warning validation Message.)

Parameters:
htmlEscape - if this message if displayed using 
 HTML, should should it be escaped?








addSuccess
void addSuccess(String validationKey,
                String code,
                String text)
Creates and adds a new Success validation Message.
 
 Escapes the message in <pre> 
 tags if displayed in HTML.







addSuccess
void addSuccess(String validationKey,
                String code,
                String text,
                ValidationHtmlEscapeType htmlEscapeType)
Creates and adds a new Success validation Message.

Parameters:
htmlEscapeType - if this message if displayed using 
 HTML, should should it be escaped?








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 elements at the specified keys
 dont not contain ERROR messages.
 
 The elements may contains
 WARNING messages.
 

 If no keys are passed, then all keys
 must be valid (synonym of isValid().







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.








createNewValidationSet
ValidationSet createNewValidationSet()
Creates a new ValidationSet.







mergeValidationSet
ValidationSet mergeValidationSet(ValidationSet validationSet)
Merges another ValidationSet.

Returns:
this, fluent-style.








mergeValidationSet
ValidationSet mergeValidationSet(String validationKeyPrefix,
                                 ValidationSet validationSet)
Merges another ValidationSet and prefixes all the
 validation keys of this set using the
 validationKeyPrefix.

Returns:
this, fluent-style.








size
int size()
The number of validation messages in this set.







getValidationResultAsJsonObject
JsonObject getValidationResultAsJsonObject()
The JsonObject in which the validation messages
 are actually stored.
 
 You can use this object to return the validation result
 as json, in a response.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`void`	`addError(String validationKey, String code, String text)` Creates and adds a new Error validation Message.
`void`	`addError(String validationKey, String code, String text, ValidationHtmlEscapeType htmlEscapeType)` Creates and adds a new Error validation Message.
`void`	`addMessage(String validationKey, ValidationLevel messageLevel, String code, String text)` Creates and adds a new validation Message.
`void`	`addMessage(String validationKey, ValidationLevel messageLevel, String code, String text, ValidationHtmlEscapeType htmlEscapeType)` Creates and adds a new validation Message.
`void`	`addMessage(String validationKey, ValidationMessage validationMessage)` Adds a new validation Message to this set, using the specified validation key.
`void`	`addSuccess(String validationKey, String code, String text)` Creates and adds a new Success validation Message.
`void`	`addSuccess(String validationKey, String code, String text, ValidationHtmlEscapeType htmlEscapeType)` Creates and adds a new Success validation Message.
`void`	`addWarning(String validationKey, String code, String text)` Creates and adds a new Warning validation Message.)
`void`	`addWarning(String validationKey, String code, String text, ValidationHtmlEscapeType htmlEscapeType)` Creates and adds a new Warning validation Message.)
`ValidationSet`	`createNewValidationSet()` Creates a new `ValidationSet`.
`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.
`JsonObject`	`getValidationResultAsJsonObject()` The `JsonObject` in which the validation messages are actually stored.
`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 elements at the specified keys dont 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 validationSet)` Merges another `ValidationSet` and prefixes all the validation keys of this set using the `validationKeyPrefix`.
`ValidationSet`	`mergeValidationSet(ValidationSet validationSet)` Merges another `ValidationSet`.
`int`	`size()` The number of validation messages in this set.