Package org.spincast.core.request

Class FormDefault

java.lang.Object

org.spincast.core.json.JsonObjectArrayBase

org.spincast.core.json.JsonObjectDefault

org.spincast.core.request.FormDefault

All Implemented Interfaces:

Iterable<Map.Entry<String,Object>>, JsonObject, JsonObjectOrArray, Form, ValidationSet

Direct Known Subclasses:

ValidationSetSimple

public class FormDefault
extends JsonObjectDefault
implements Form

Nested Class Summary

Nested classes/interfaces inherited from class org.spincast.core.json.JsonObjectDefault

JsonObjectDefault.IFirstElementGetter<T>

Nested classes/interfaces inherited from class org.spincast.core.json.JsonObjectArrayBase

JsonObjectArrayBase.JsonPathCachingItem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT_KEYS_HAS_ERRORS
static final String	ELEMENT_KEYS_HAS_SUCCESSES
static final String	ELEMENT_KEYS_HAS_WARNINGS
static final String	ELEMENT_KEYS_IS_VALID

Fields inherited from class org.spincast.core.json.JsonObjectDefault

logger

Fields inherited from class org.spincast.core.json.JsonObjectArrayBase

defaultElementValidator

Constructor Summary

Constructors

Constructor	Description
FormDefault(String formName, JsonObject initialFormData, JsonManager jsonManager, SpincastUtils spincastUtils, ObjectConverter objectConverter, Dictionary dictionary, XmlManager xmlManager, SpincastConfig spincastConfig, Validators validators, FormFactory formFactory, ValidationFactory validationFactory)

Method Summary

Modifier and Type	Method	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 level, String code, String text)	Creates and adds a new validation Message.
void	addMessage(String validationKey, ValidationLevel level, String code, String text, ValidationHtmlEscapeType htmlEscapeType)	Creates and adds a new validation Message.
void	addMessage(String validationKey, ValidationMessage message)	Adds a new validation Message to this set, using the specified validation key.
protected void	addMessageFormattedSpecifickey(String key, List<ValidationMessage> messages, ValidationMessageFormatType formatType, StringBuilder textBuilder, JsonObject jsonObject)
protected void	addMessagesFormattedSpecifickeyHtml(String key, StringBuilder textBuilder, List<ValidationMessage> messages)
protected void	addMessagesFormattedSpecifickeyTextPlain(String key, StringBuilder textBuilder, List<ValidationMessage> messages)
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.)
void	clearAllValidation()	Removes all previously added messages and reset the validation status.
ValidationSet	createNewValidationSet()	Creates a new ValidationSet.
protected String	getCssClassForErrorkey()	The css class to use for a key's <li> element.
protected String	getCssClassForErrorMessage()	The css class to use for an error message's <li> element.
protected String	getCssClassForSuccessMessage()
protected String	getCssClassForWarningMessage()
protected String	getDefaultErrorMessageText(String key)
protected Dictionary	getDictionary()
protected FormFactory	getFormFactory()
String	getFormName()	The name of the form.
Map<String,List<ValidationMessage>>	getMessages()	Gets the validation keys and their associated messages.
List<ValidationMessage>	getMessages(String key)	Gets the validation messages for the specified key.
String	getMessagesFormatted(String jsonPath, 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.
protected SpincastConfig	getSpincastConfig()
protected ValidationFactory	getValidationFactory()
JsonObject	getValidationResultAsJsonObject()	The JsonObject in which the validation messages are actually stored.
protected String	getWholeValidationKey()
protected XmlManager	getXmlManager()
boolean	hasMessages()	Does this validation set contain any validation Messages?
boolean	hasMessages(String key)	Does the the element at the specified key contains validation Messages?
protected void	init()
boolean	isError()	Returns true if the validation set contains at least one ERROR message.
boolean	isError(String key)	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 key)	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... validationKeys)	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 key)	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.
void	setValidationObject(JsonObject validationObject)	Sets the JsonObject to use to store the validation messages.
int	size()	The size of the object.
protected static LinkedHashMap<String,List<ValidationMessage>>	toLinkedHashMap(String key, List<ValidationMessage> messages)
protected static LinkedHashMap<String,List<ValidationMessage>>	toMessages(List<ValidationSet> existingResults)
String	toString()
protected boolean	usePrettyJson()
protected boolean	usePrettyXml()
Validators	validators()	Returns the Validators.

Methods inherited from class org.spincast.core.json.JsonObjectDefault

clear, clone, convert, convertToPlainMap, getElementNoKeyParsing, getMap, isElementExistsNoKeyParsing, isEquivalentTo, iterator, merge, merge, merge, merge, merge, putAsIs, remove, removeNoKeyParsing, setNoKeyParsing, setNoKeyParsing, transformAll

Methods inherited from class org.spincast.core.json.JsonObjectArrayBase

clone, contains, getArrayFirst, getArrayFirstBigDecimal, getArrayFirstBigDecimal, getArrayFirstBigDecimal, getArrayFirstBigDecimalNoKeyParsing, getArrayFirstBigDecimalNoKeyParsing, getArrayFirstBoolean, getArrayFirstBoolean, getArrayFirstBoolean, getArrayFirstBooleanNoKeyParsing, getArrayFirstBooleanNoKeyParsing, getArrayFirstBytesFromBase64String, getArrayFirstBytesFromBase64String, getArrayFirstBytesFromBase64String, getArrayFirstBytesFromBase64StringNoKeyParsing, getArrayFirstBytesFromBase64StringNoKeyParsing, getArrayFirstDate, getArrayFirstDate, getArrayFirstDate, getArrayFirstDateNoKeyParsing, getArrayFirstDateNoKeyParsing, getArrayFirstDouble, getArrayFirstDouble, getArrayFirstDouble, getArrayFirstDoubleNoKeyParsing, getArrayFirstDoubleNoKeyParsing, getArrayFirstFloat, getArrayFirstFloat, getArrayFirstFloat, getArrayFirstFloatNoKeyParsing, getArrayFirstFloatNoKeyParsing, getArrayFirstInstant, getArrayFirstInstant, getArrayFirstInstant, getArrayFirstInstantNoKeyParsing, getArrayFirstInstantNoKeyParsing, getArrayFirstInteger, getArrayFirstInteger, getArrayFirstInteger, getArrayFirstIntegerNoKeyParsing, getArrayFirstIntegerNoKeyParsing, getArrayFirstJsonArray, getArrayFirstJsonArray, getArrayFirstJsonArray, getArrayFirstJsonArrayNoKeyParsing, getArrayFirstJsonArrayNoKeyParsing, getArrayFirstJsonObject, getArrayFirstJsonObject, getArrayFirstJsonObject, getArrayFirstJsonObjectNoKeyParsing, getArrayFirstJsonObjectNoKeyParsing, getArrayFirstLong, getArrayFirstLong, getArrayFirstLong, getArrayFirstLongNoKeyParsing, getArrayFirstLongNoKeyParsing, getArrayFirstString, getArrayFirstString, getArrayFirstString, getArrayFirstStringNoKeyParsing, getArrayFirstStringNoKeyParsing, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimalElement, getBigDecimalFromObject, getBigDecimalNoKeyParsing, getBigDecimalNoKeyParsing, getBoolean, getBoolean, getBoolean, getBooleanElement, getBooleanFromObject, getBooleanNoKeyParsing, getBooleanNoKeyParsing, getBytesFromBase64String, getBytesFromBase64String, getBytesFromBase64String, getBytesFromBase64StringElement, getBytesFromBase64StringNoKeyParsing, getBytesFromBase64StringNoKeyParsing, getBytesFromBase64StringValueFromObject, getDate, getDate, getDate, getDateElement, getDateFromObject, getDateNoKeyParsing, getDateNoKeyParsing, getdefaultElementValidator, getDouble, getDouble, getDouble, getDoubleElement, getDoubleFromObject, getDoubleNoKeyParsing, getDoubleNoKeyParsing, getElement, getFloat, getFloat, getFloat, getFloatElement, getFloatFromObject, getFloatNoKeyParsing, getFloatNoKeyParsing, getInstant, getInstant, getInstant, getInstantElement, getInstantFromObject, getInstantNoKeyParsing, getInstantNoKeyParsing, getInteger, getInteger, getInteger, getIntegerElement, getIntegerFromObject, getIntegerNoKeyParsing, getIntegerNoKeyParsing, getJsonArray, getJsonArray, getJsonArray, getJsonArrayFromObject, getJsonArrayNoKeyParsing, getJsonArrayNoKeyParsing, getJsonArrayOrEmpty, getJsonArrayOrEmpty, getJsonArrayOrEmptyNoKeyParsing, getJsonManager, getJsonObject, getJsonObject, getJsonObject, getJsonObject, getJsonObjectFromObject, getJsonObjectNoKeyParsing, getJsonObjectNoKeyParsing, getJsonObjectOrEmpty, getJsonObjectOrEmpty, getJsonObjectOrEmptyNoKeyParsing, getJsonPathCachingMap, getLong, getLong, getLong, getLongElement, getLongFromObject, getLongNoKeyParsing, getLongNoKeyParsing, getObject, getObject, getObject, getObjectConverter, getObjectNoKeyParsing, getObjectNoKeyParsing, getSpincastUtils, getString, getString, getString, getString, getStringFromObject, getStringNoKeyParsing, getStringNoKeyParsing, getTrimTransformer, isCanBeConvertedToBigDecimal, isCanBeConvertedToBigDecimal, isCanBeConvertedToBigDecimalNoKeyParsing, isCanBeConvertedToBoolean, isCanBeConvertedToBoolean, isCanBeConvertedToBooleanNoKeyParsing, isCanBeConvertedToByteArray, isCanBeConvertedToByteArray, isCanBeConvertedToByteArrayNoKeyParsing, isCanBeConvertedToDate, isCanBeConvertedToDate, isCanBeConvertedToDateNoKeyParsing, isCanBeConvertedToDouble, isCanBeConvertedToDouble, isCanBeConvertedToDoubleNoKeyParsing, isCanBeConvertedToFloat, isCanBeConvertedToFloat, isCanBeConvertedToFloatNoKeyParsing, isCanBeConvertedToInteger, isCanBeConvertedToInteger, isCanBeConvertedToIntegerNoKeyParsing, isCanBeConvertedToJsonArray, isCanBeConvertedToJsonArray, isCanBeConvertedToJsonArrayNoKeyParsing, isCanBeConvertedToJsonObject, isCanBeConvertedToJsonObject, isCanBeConvertedToJsonObjectNoKeyParsing, isCanBeConvertedToLong, isCanBeConvertedToLong, isCanBeConvertedToLongNoKeyParsing, isCanBeConvertedToString, isCanBeConvertedToString, isCanBeConvertedToStringNoKeyParsing, isMutable, isNull, isNullNoKeyParsing, isOfTypeBigDecimal, isOfTypeBigDecimalNoKeyParsing, isOfTypeBoolean, isOfTypeBoolean, isOfTypeBooleanNoKeyParsing, isOfTypeByteArray, isOfTypeByteArray, isOfTypeByteArrayNoKeyParsing, isOfTypeDate, isOfTypeDate, isOfTypeDateNoKeyParsing, isOfTypeDouble, isOfTypeDouble, isOfTypeDoubleNoKeyParsing, isOfTypeeBigDecimal, isOfTypeFloat, isOfTypeFloat, isOfTypeFloatNoKeyParsing, isOfTypeInteger, isOfTypeInteger, isOfTypeIntegerNoKeyParsing, isOfTypeJsonArray, isOfTypeJsonArray, isOfTypeJsonArrayNoKeyParsing, isOfTypeJsonObject, isOfTypeJsonObject, isOfTypeJsonObjectNoKeyParsing, isOfTypeLong, isOfTypeLong, isOfTypeLongNoKeyParsing, isOfTypeString, isOfTypeString, isOfTypeStringNoKeyParsing, isPresent, put, set, set, setIfAbsent, setIfAbsent, toJsonString, toJsonString, transform, transformAll, trim, trimAll, trimAll, validateIsNull

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.spincast.core.json.JsonObject

clone, convert, convertToPlainMap, getArrayFirstBigDecimalNoKeyParsing, getArrayFirstBigDecimalNoKeyParsing, getArrayFirstBooleanNoKeyParsing, getArrayFirstBooleanNoKeyParsing, getArrayFirstBytesFromBase64StringNoKeyParsing, getArrayFirstBytesFromBase64StringNoKeyParsing, getArrayFirstDateNoKeyParsing, getArrayFirstDateNoKeyParsing, getArrayFirstDoubleNoKeyParsing, getArrayFirstDoubleNoKeyParsing, getArrayFirstFloatNoKeyParsing, getArrayFirstFloatNoKeyParsing, getArrayFirstIntegerNoKeyParsing, getArrayFirstIntegerNoKeyParsing, getArrayFirstJsonArrayNoKeyParsing, getArrayFirstJsonArrayNoKeyParsing, getArrayFirstJsonObjectNoKeyParsing, getArrayFirstJsonObjectNoKeyParsing, getArrayFirstLongNoKeyParsing, getArrayFirstLongNoKeyParsing, getArrayFirstStringNoKeyParsing, getArrayFirstStringNoKeyParsing, getBigDecimalNoKeyParsing, getBigDecimalNoKeyParsing, getBooleanNoKeyParsing, getBooleanNoKeyParsing, getBytesFromBase64StringNoKeyParsing, getBytesFromBase64StringNoKeyParsing, getDateNoKeyParsing, getDateNoKeyParsing, getDoubleNoKeyParsing, getDoubleNoKeyParsing, getFloatNoKeyParsing, getFloatNoKeyParsing, getInstantNoKeyParsing, getInstantNoKeyParsing, getIntegerNoKeyParsing, getIntegerNoKeyParsing, getJsonArrayNoKeyParsing, getJsonArrayNoKeyParsing, getJsonArrayOrEmptyNoKeyParsing, getJsonObjectNoKeyParsing, getJsonObjectNoKeyParsing, getJsonObjectOrEmptyNoKeyParsing, getLongNoKeyParsing, getLongNoKeyParsing, getObjectNoKeyParsing, getObjectNoKeyParsing, getStringNoKeyParsing, getStringNoKeyParsing, isCanBeConvertedToBigDecimalNoKeyParsing, isCanBeConvertedToBooleanNoKeyParsing, isCanBeConvertedToByteArrayNoKeyParsing, isCanBeConvertedToDateNoKeyParsing, isCanBeConvertedToDoubleNoKeyParsing, isCanBeConvertedToFloatNoKeyParsing, isCanBeConvertedToIntegerNoKeyParsing, isCanBeConvertedToJsonArrayNoKeyParsing, isCanBeConvertedToJsonObjectNoKeyParsing, isCanBeConvertedToLongNoKeyParsing, isCanBeConvertedToStringNoKeyParsing, isElementExistsNoKeyParsing, isEquivalentTo, isNullNoKeyParsing, isOfTypeBigDecimalNoKeyParsing, isOfTypeBooleanNoKeyParsing, isOfTypeByteArrayNoKeyParsing, isOfTypeDateNoKeyParsing, isOfTypeDoubleNoKeyParsing, isOfTypeFloatNoKeyParsing, isOfTypeIntegerNoKeyParsing, isOfTypeJsonArrayNoKeyParsing, isOfTypeJsonObjectNoKeyParsing, isOfTypeLongNoKeyParsing, isOfTypeStringNoKeyParsing, merge, merge, merge, merge, merge, removeNoKeyParsing, setNoKeyParsing, setNoKeyParsing

Methods inherited from interface org.spincast.core.json.JsonObjectOrArray

clear, contains, getArrayFirstBigDecimal, getArrayFirstBigDecimal, getArrayFirstBoolean, getArrayFirstBoolean, getArrayFirstBytesFromBase64String, getArrayFirstBytesFromBase64String, getArrayFirstDate, getArrayFirstDate, getArrayFirstDouble, getArrayFirstDouble, getArrayFirstFloat, getArrayFirstFloat, getArrayFirstInstant, getArrayFirstInstant, getArrayFirstInteger, getArrayFirstInteger, getArrayFirstJsonArray, getArrayFirstJsonArray, getArrayFirstJsonObject, getArrayFirstJsonObject, getArrayFirstLong, getArrayFirstLong, getArrayFirstString, getArrayFirstString, getBigDecimal, getBigDecimal, getBoolean, getBoolean, getBytesFromBase64String, getBytesFromBase64String, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInstant, getInstant, getInteger, getInteger, getJsonArray, getJsonArray, getJsonArrayOrEmpty, getJsonArrayOrEmpty, getJsonObject, getJsonObject, getJsonObjectOrEmpty, getJsonObjectOrEmpty, getLong, getLong, getObject, getObject, getString, getString, isCanBeConvertedToBigDecimal, isCanBeConvertedToBoolean, isCanBeConvertedToByteArray, isCanBeConvertedToDate, isCanBeConvertedToDouble, isCanBeConvertedToFloat, isCanBeConvertedToInteger, isCanBeConvertedToJsonArray, isCanBeConvertedToJsonObject, isCanBeConvertedToLong, isCanBeConvertedToString, isMutable, isNull, isOfTypeBigDecimal, isOfTypeBoolean, isOfTypeByteArray, isOfTypeDate, isOfTypeDouble, isOfTypeFloat, isOfTypeInteger, isOfTypeJsonArray, isOfTypeJsonObject, isOfTypeLong, isOfTypeString, isPresent, remove, set, set, setIfAbsent, setIfAbsent, toJsonString, toJsonString, transform, transformAll, transformAll, trim, trimAll, trimAll

Field Details

ELEMENT_KEYS_IS_VALID

public static final String ELEMENT_KEYS_IS_VALID

See Also:

• Constant Field Values

ELEMENT_KEYS_HAS_SUCCESSES

public static final String ELEMENT_KEYS_HAS_SUCCESSES

See Also:

• Constant Field Values

ELEMENT_KEYS_HAS_WARNINGS

public static final String ELEMENT_KEYS_HAS_WARNINGS

See Also:

• Constant Field Values

ELEMENT_KEYS_HAS_ERRORS

public static final String ELEMENT_KEYS_HAS_ERRORS

See Also:

• Constant Field Values

Constructor Details

FormDefault

public FormDefault(String formName,
 @Nullable
 JsonObject initialFormData,
 JsonManager jsonManager,
 SpincastUtils spincastUtils,
 ObjectConverter objectConverter,
 Dictionary dictionary,
 XmlManager xmlManager,
 SpincastConfig spincastConfig,
 Validators validators,
 FormFactory formFactory,
 ValidationFactory validationFactory)

Method Details

init

@Inject
protected void init()

getFormName

public String getFormName()

Description copied from interface: Form

The name of the form.

Specified by:

getFormName in interface Form

getDictionary

protected Dictionary getDictionary()

getXmlManager

protected XmlManager getXmlManager()

getSpincastConfig

protected SpincastConfig getSpincastConfig()

getFormFactory

protected FormFactory getFormFactory()

getValidationFactory

protected ValidationFactory getValidationFactory()

validators

public Validators validators()

Description copied from interface: Form

Returns the Validators.

Specified by:

validators in interface Form

getDefaultErrorMessageText

protected String getDefaultErrorMessageText(String key)

toLinkedHashMap

protected static LinkedHashMap<String,List<ValidationMessage>> toLinkedHashMap(String key,
 List<ValidationMessage> messages)

toMessages

protected static LinkedHashMap<String,List<ValidationMessage>> toMessages(List<ValidationSet> existingResults)

getWholeValidationKey

protected String getWholeValidationKey()

getValidationResultAsJsonObject

public JsonObject getValidationResultAsJsonObject()

Description copied from interface: ValidationSet

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.

Specified by:

getValidationResultAsJsonObject in interface ValidationSet

setValidationObject

public void setValidationObject(JsonObject validationObject)

Description copied from interface: Form

Sets the JsonObject to use to store the validation messages.

If there are existing validation messages on the current validation object, they will be merged to the new object!

Beware that changing this object may disconnect the validation messages of this form from a global validation element on the response's model!

Specified by:

setValidationObject in interface Form

addMessage

public void addMessage(String validationKey,
 ValidationMessage message)

Description copied from interface: ValidationSet

Adds a new validation Message to this set, using the specified validation key.

Specified by:

addMessage in interface ValidationSet

addMessage

public void addMessage(String validationKey,
 ValidationLevel level,
 String code,
 String text)

Description copied from interface: ValidationSet

Creates and adds a new validation Message.

Escapes the message in <pre> tags if displayed in HTML.

Specified by:

addMessage in interface ValidationSet

addMessage

public void addMessage(String validationKey,
 ValidationLevel level,
 String code,
 String text,
 ValidationHtmlEscapeType htmlEscapeType)

Description copied from interface: ValidationSet

Creates and adds a new validation Message.

Specified by:

addMessage in interface ValidationSet

addError

public void addError(String validationKey,
 String code,
 String text)

Description copied from interface: ValidationSet

Creates and adds a new Error validation Message.

Escapes the message in <pre> tags if displayed in HTML.

Specified by:

addError in interface ValidationSet

addError

public void addError(String validationKey,
 String code,
 String text,
 ValidationHtmlEscapeType htmlEscapeType)

Description copied from interface: ValidationSet

Creates and adds a new Error validation Message.

Specified by:

addError in interface ValidationSet

addWarning

public void addWarning(String validationKey,
 String code,
 String text)

Description copied from interface: ValidationSet

Creates and adds a new Warning validation Message.)

Escapes the message in <pre> tags if displayed in HTML.

Specified by:

addWarning in interface ValidationSet

addWarning

public void addWarning(String validationKey,
 String code,
 String text,
 ValidationHtmlEscapeType htmlEscapeType)

Description copied from interface: ValidationSet

Creates and adds a new Warning validation Message.)

Specified by:

addWarning in interface ValidationSet

addSuccess

public void addSuccess(String validationKey,
 String code,
 String text)

Description copied from interface: ValidationSet

Creates and adds a new Success validation Message.

Escapes the message in <pre> tags if displayed in HTML.

Specified by:

addSuccess in interface ValidationSet

addSuccess

public void addSuccess(String validationKey,
 String code,
 String text,
 ValidationHtmlEscapeType htmlEscapeType)

Description copied from interface: ValidationSet

Creates and adds a new Success validation Message.

Specified by:

addSuccess in interface ValidationSet

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

hasMessages

public boolean hasMessages()

Description copied from interface: ValidationSet

Does this validation set contain any validation Messages?

Specified by:

hasMessages in interface ValidationSet

hasMessages

public boolean hasMessages(String key)

Description copied from interface: ValidationSet

Does the the element at the specified key contains validation Messages?

Specified by:

hasMessages in interface ValidationSet

isWarning

public boolean isWarning()

Description copied from interface: ValidationSet

Returns true if the validation set contains at least one WARNING message, but no ERROR messages.

Specified by:

isWarning in interface ValidationSet

isWarning

public boolean isWarning(String key)

Description copied from interface: ValidationSet

Returns true if the validation set for the element at the specified key contains at least one WARNING message, but no ERROR messages.

Specified by:

isWarning in interface ValidationSet

isSuccess

public boolean isSuccess()

Description copied from interface: ValidationSet

Returns true if the validation set only contains SUCCESS messages (or contains no messages at all).

Specified by:

isSuccess in interface ValidationSet

isSuccess

public boolean isSuccess(String key)

Description copied from interface: ValidationSet

Returns true if the validation set for the element at the specified key only contains SUCCESS messages (or contains no messages at all).

Specified by:

isSuccess in interface ValidationSet

isError

public boolean isError()

Description copied from interface: ValidationSet

Returns true if the validation set contains at least one ERROR message.

Specified by:

isError in interface ValidationSet

isError

public boolean isError(String key)

Description copied from interface: ValidationSet

Returns true if the validation set for the element at the specified key contains at least one ERROR message.

Specified by:

isError in interface ValidationSet

isValid

public boolean isValid()

Description copied from interface: ValidationSet

Returns true if the validation set does not contain ERROR messages. The set may contain WARNING messages.

This is a synonym of !isError().

Specified by:

isValid in interface ValidationSet

isValid

public boolean isValid(String... validationKeys)

Description copied from interface: ValidationSet

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 ValidationSet.isValid().

Specified by:

isValid in interface ValidationSet

getMessages

public Map<String,List<ValidationMessage>> getMessages()

Description copied from interface: ValidationSet

Gets the validation keys and their associated messages.

The Map and the lists are immutable.

Specified by:

getMessages in interface ValidationSet

getMessages

public List<ValidationMessage> getMessages(String key)

Description copied from interface: ValidationSet

Gets the validation messages for the specified key.

The list is immutable.

Specified by:

getMessages in interface ValidationSet

getMessagesFormatted

public String getMessagesFormatted(ValidationMessageFormatType formatType)

Description copied from interface: ValidationSet

Quick way to get a formatted version of all validation messages.

Specified by:

getMessagesFormatted in interface ValidationSet

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.

getMessagesFormatted

public String getMessagesFormatted(String jsonPath,
 ValidationMessageFormatType formatType)

Description copied from interface: ValidationSet

Quick way to get a formatted version of the validation messages for the specified key.

Specified by:

getMessagesFormatted in interface ValidationSet

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.

usePrettyJson

protected boolean usePrettyJson()

usePrettyXml

protected boolean usePrettyXml()

addMessageFormattedSpecifickey

protected void addMessageFormattedSpecifickey(String key,
 List<ValidationMessage> messages,
 ValidationMessageFormatType formatType,
 StringBuilder textBuilder,
 JsonObject jsonObject)

addMessagesFormattedSpecifickeyTextPlain

protected void addMessagesFormattedSpecifickeyTextPlain(String key,
 StringBuilder textBuilder,
 List<ValidationMessage> messages)

addMessagesFormattedSpecifickeyHtml

protected void addMessagesFormattedSpecifickeyHtml(String key,
 StringBuilder textBuilder,
 List<ValidationMessage> messages)

getCssClassForErrorkey

protected String getCssClassForErrorkey()

The css class to use for a key's <li> element.

getCssClassForErrorMessage

protected String getCssClassForErrorMessage()

The css class to use for an error message's <li> element.

getCssClassForSuccessMessage

protected String getCssClassForSuccessMessage()

getCssClassForWarningMessage

protected String getCssClassForWarningMessage()

createNewValidationSet

public ValidationSet createNewValidationSet()

Description copied from interface: ValidationSet

Creates a new ValidationSet.

Specified by:

createNewValidationSet in interface ValidationSet

mergeValidationSet

public ValidationSet mergeValidationSet(ValidationSet validationSet)

Description copied from interface: ValidationSet

Merges another ValidationSet.

Specified by:

mergeValidationSet in interface ValidationSet

Returns:

this, fluent-style.

mergeValidationSet

public ValidationSet mergeValidationSet(String validationKeyPrefix,
 ValidationSet validationSet)

Description copied from interface: ValidationSet

Merges another ValidationSet and prefixes all the validation keys of this set using the validationKeyPrefix.

Specified by:

mergeValidationSet in interface ValidationSet

Returns:

this, fluent-style.

size

public int size()

Description copied from interface: JsonObjectOrArray

The size of the object.

Specified by:

size in interface JsonObjectOrArray

Specified by:

size in interface ValidationSet

Overrides:

size in class JsonObjectDefault

clearAllValidation

public void clearAllValidation()

Description copied from interface: ValidationSet

Removes all previously added messages and reset the validation status.

Specified by:

clearAllValidation in interface ValidationSet

toString

public String toString()

Overrides:

toString in class JsonObjectArrayBase