public class FormDefault extends JsonObjectDefault implements Form
JsonObjectDefault.IFirstElementGetter<T>JsonObjectArrayBase.JsonPathCachingItem| Modifier and Type | Field and Description |
|---|---|
static String |
ELEMENT_KEYS_HAS_ERRORS |
static String |
ELEMENT_KEYS_HAS_SUCCESSES |
static String |
ELEMENT_KEYS_HAS_WARNINGS |
static String |
ELEMENT_KEYS_IS_VALID |
loggerdefaultElementValidator| Constructor and Description |
|---|
FormDefault(String formName,
JsonObject initialFormData,
JsonManager jsonManager,
SpincastUtils spincastUtils,
ObjectConverter objectConverter,
Dictionary dictionary,
XmlManager xmlManager,
SpincastConfig spincastConfig,
Validators validators,
FormFactory formFactory,
ValidationFactory validationFactory) |
| Modifier and Type | Method and Description |
|---|---|
void |
addError(String validationKey,
String code,
String text)
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,
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 |
addWarning(String validationKey,
String code,
String text)
Creates and adds a new Warning validation Message.)
|
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) |
protected boolean |
usePrettyJson() |
protected boolean |
usePrettyXml() |
Validators |
validators()
Returns the
Validators. |
clear, clone, convert, convertToPlainMap, getElementNoKeyParsing, getMap, isElementExistsNoKeyParsing, isEquivalentTo, iterator, merge, merge, merge, merge, merge, putAsIs, remove, removeNoKeyParsing, setNoKeyParsing, setNoKeyParsing, transformAllclone, 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, isElementExists, 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, put, set, set, toJsonString, toJsonString, toString, transform, transformAll, trim, trimAll, trimAll, validateIsNullequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitclone, 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, setNoKeyParsingclear, 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, isElementExists, isMutable, isNull, isOfTypeBigDecimal, isOfTypeBoolean, isOfTypeByteArray, isOfTypeDate, isOfTypeDouble, isOfTypeFloat, isOfTypeInteger, isOfTypeJsonArray, isOfTypeJsonObject, isOfTypeLong, isOfTypeString, remove, set, set, toJsonString, toJsonString, transform, transformAll, transformAll, trim, trimAll, trimAllforEach, iterator, spliteratorpublic static final String ELEMENT_KEYS_IS_VALID
public static final String ELEMENT_KEYS_HAS_SUCCESSES
public static final String ELEMENT_KEYS_HAS_WARNINGS
public static final String ELEMENT_KEYS_HAS_ERRORS
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)
@Inject protected void init()
public String getFormName()
FormgetFormName in interface Formprotected Dictionary getDictionary()
protected XmlManager getXmlManager()
protected SpincastConfig getSpincastConfig()
protected FormFactory getFormFactory()
protected ValidationFactory getValidationFactory()
public Validators validators()
FormValidators.validators in interface Formprotected static LinkedHashMap<String,List<ValidationMessage>> toLinkedHashMap(String key, List<ValidationMessage> messages)
protected static LinkedHashMap<String,List<ValidationMessage>> toMessages(List<ValidationSet> existingResults)
protected String getWholeValidationKey()
public JsonObject getValidationResultAsJsonObject()
ValidationSetJsonObject in which the validation messages
are actually stored.
You can use this object to return the validation result as json, in a response.
getValidationResultAsJsonObject in interface ValidationSetpublic void setValidationObject(JsonObject validationObject)
FormJsonObject 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!
setValidationObject in interface Formpublic void addMessage(String validationKey, ValidationMessage message)
ValidationSetaddMessage in interface ValidationSetpublic void addMessage(String validationKey, ValidationLevel level, String code, String text)
ValidationSetaddMessage in interface ValidationSetpublic void addError(String validationKey, String code, String text)
ValidationSetaddError in interface ValidationSetpublic void addWarning(String validationKey, String code, String text)
ValidationSetaddWarning in interface ValidationSetpublic void addSuccess(String validationKey, String code, String text)
ValidationSetaddSuccess in interface ValidationSetpublic boolean hasMessages()
ValidationSethasMessages in interface ValidationSetpublic boolean hasMessages(String key)
ValidationSethasMessages in interface ValidationSetpublic boolean isWarning()
ValidationSettrue if the validation set
contains at least one WARNING message, but no
ERROR messages.isWarning in interface ValidationSetpublic boolean isWarning(String key)
ValidationSettrue if the validation set
for the element at the specified key contains at
least one WARNING message, but no
ERROR messages.isWarning in interface ValidationSetpublic boolean isSuccess()
ValidationSettrue if the validation set
only contains SUCCESS messages
(or contains no messages at all).isSuccess in interface ValidationSetpublic boolean isSuccess(String key)
ValidationSettrue if the validation set
for the element at the specified key only contains
SUCCESS messages
(or contains no messages at all).isSuccess in interface ValidationSetpublic boolean isError()
ValidationSettrue if the validation set
contains at least one ERROR message.isError in interface ValidationSetpublic boolean isError(String key)
ValidationSettrue if the validation set
for the element at the specified key contains
at least one ERROR message.isError in interface ValidationSetpublic boolean isValid()
ValidationSettrue if the validation set
does not contain ERROR messages.
The set may contain
WARNING messages.
This is a synonym of !isError().
isValid in interface ValidationSetpublic boolean isValid(String... validationKeys)
ValidationSettrue 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().
isValid in interface ValidationSetpublic Map<String,List<ValidationMessage>> getMessages()
ValidationSetThe Map and the lists are immutable.
getMessages in interface ValidationSetpublic List<ValidationMessage> getMessages(String key)
ValidationSetThe list is immutable.
getMessages in interface ValidationSetpublic String getMessagesFormatted(ValidationMessageFormatType formatType)
ValidationSetgetMessagesFormatted in interface ValidationSetformatType - The type of output for the messages (Text, HTML, Json or XML).null if
there are no validation messages.public String getMessagesFormatted(String jsonPath, ValidationMessageFormatType formatType)
ValidationSetgetMessagesFormatted in interface ValidationSetformatType - The type of output for the messages (Text, HTML, Json or XML).null if
there are no validation messages.protected boolean usePrettyJson()
protected boolean usePrettyXml()
protected void addMessageFormattedSpecifickey(String key, List<ValidationMessage> messages, ValidationMessageFormatType formatType, StringBuilder textBuilder, JsonObject jsonObject)
protected void addMessagesFormattedSpecifickeyTextPlain(String key, StringBuilder textBuilder, List<ValidationMessage> messages)
protected void addMessagesFormattedSpecifickeyHtml(String key, StringBuilder textBuilder, List<ValidationMessage> messages)
protected String getCssClassForErrorkey()
protected String getCssClassForErrorMessage()
protected String getCssClassForSuccessMessage()
protected String getCssClassForWarningMessage()
public ValidationSet createNewValidationSet()
ValidationSetValidationSet.createNewValidationSet in interface ValidationSetpublic ValidationSet mergeValidationSet(ValidationSet validationSet)
ValidationSetValidationSet.mergeValidationSet in interface ValidationSetpublic ValidationSet mergeValidationSet(String validationKeyPrefix, ValidationSet validationSet)
ValidationSetValidationSet and prefixes all the
validation keys of this set using the
validationKeyPrefix.mergeValidationSet in interface ValidationSetpublic int size()
JsonObjectOrArraysize in interface JsonObjectOrArraysize in interface ValidationSetsize in class JsonObjectDefaultCopyright © 2018. All rights reserved.