|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.validation.AbstractErrors
public abstract class AbstractErrors
Abstract implementation of the Errors interface. Provides common
access to evaluated errors; however, does not define concrete management
of ObjectErrors and FieldErrors.
| Field Summary |
|---|
| Fields inherited from interface org.springframework.validation.Errors |
|---|
NESTED_PATH_SEPARATOR |
| Constructor Summary | |
|---|---|
AbstractErrors()
|
|
| Method Summary | |
|---|---|
protected String |
canonicalFieldName(String field)
Determine the canonical field name for the given field. |
protected void |
doSetNestedPath(String nestedPath)
Actually set the nested path. |
protected String |
fixedField(String field)
Transform the given field into its full path, regarding the nested path of this instance. |
List<ObjectError> |
getAllErrors()
Get all errors, both global and field ones. |
int |
getErrorCount()
Return the total number of errors. |
FieldError |
getFieldError()
Get the first error associated with a field, if any. |
FieldError |
getFieldError(String field)
Get the first error associated with the given field, if any. |
int |
getFieldErrorCount()
Return the number of errors associated with a field. |
int |
getFieldErrorCount(String field)
Return the number of errors associated with the given field. |
List<FieldError> |
getFieldErrors(String field)
Get all errors associated with the given field. |
Class |
getFieldType(String field)
Return the type of a given field. |
ObjectError |
getGlobalError()
Get the first global error, if any. |
int |
getGlobalErrorCount()
Return the number of global errors. |
String |
getNestedPath()
Return the current nested path of this Errors object. |
boolean |
hasErrors()
Return if there were any errors. |
boolean |
hasFieldErrors()
Are there any field errors? |
boolean |
hasFieldErrors(String field)
Are there any errors associated with the given field? |
boolean |
hasGlobalErrors()
Are there any global errors? |
protected boolean |
isMatchingFieldError(String field,
FieldError fieldError)
Check whether the given FieldError matches the given field. |
void |
popNestedPath()
Pop the former nested path from the nested path stack. |
void |
pushNestedPath(String subPath)
Push the given sub path onto the nested path stack. |
void |
reject(String errorCode)
Register a global error for the entire target object, using the given error description. |
void |
reject(String errorCode,
String defaultMessage)
Register a global error for the entire target object, using the given error description. |
void |
rejectValue(String field,
String errorCode)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description. |
void |
rejectValue(String field,
String errorCode,
String defaultMessage)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description. |
void |
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.springframework.validation.Errors |
|---|
addAllErrors, getFieldErrors, getFieldValue, getGlobalErrors, getObjectName, reject, rejectValue |
| Constructor Detail |
|---|
public AbstractErrors()
| Method Detail |
|---|
public void setNestedPath(String nestedPath)
ErrorsFor example, an address validator could validate the subobject "address" of a customer object.
setNestedPath in interface ErrorsnestedPath - nested path within this object,
e.g. "address" (defaults to "", null is also acceptable).
Can end with a dot: both "address" and "address." are valid.public String getNestedPath()
ErrorsErrors object.
Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
getNestedPath in interface Errorspublic void pushNestedPath(String subPath)
ErrorsA Errors.popNestedPath() call will reset the original
nested path before the corresponding
pushNestedPath(String) call.
Using the nested path stack allows to set temporary nested paths for subobjects without having to worry about a temporary path holder.
For example: current path "spouse.", pushNestedPath("child") -> result path "spouse.child."; popNestedPath() -> "spouse." again.
pushNestedPath in interface ErrorssubPath - the sub path to push onto the nested path stackErrors.popNestedPath()
public void popNestedPath()
throws IllegalArgumentException
Errors
popNestedPath in interface ErrorsIllegalArgumentExceptionErrors.pushNestedPath(java.lang.String)protected void doSetNestedPath(String nestedPath)
protected String fixedField(String field)
protected String canonicalFieldName(String field)
The default implementation simply returns the field name as-is.
field - the original field name
public void reject(String errorCode)
Errors
reject in interface ErrorserrorCode - error code, interpretable as a message key
public void reject(String errorCode,
String defaultMessage)
Errors
reject in interface ErrorserrorCode - error code, interpretable as a message keydefaultMessage - fallback default message
public void rejectValue(String field,
String errorCode)
ErrorsThe field name may be null or empty String to indicate
the current object itself rather than a field of it. This may result
in a corresponding field error within the nested object graph or a
global error if the current object is the top object.
rejectValue in interface Errorsfield - the field name (may be null or empty String)errorCode - error code, interpretable as a message keyErrors.getNestedPath()
public void rejectValue(String field,
String errorCode,
String defaultMessage)
ErrorsThe field name may be null or empty String to indicate
the current object itself rather than a field of it. This may result
in a corresponding field error within the nested object graph or a
global error if the current object is the top object.
rejectValue in interface Errorsfield - the field name (may be null or empty String)errorCode - error code, interpretable as a message keydefaultMessage - fallback default messageErrors.getNestedPath()public boolean hasErrors()
Errors
hasErrors in interface Errorspublic int getErrorCount()
Errors
getErrorCount in interface Errorspublic List<ObjectError> getAllErrors()
Errors
getAllErrors in interface ErrorsObjectError instancespublic boolean hasGlobalErrors()
Errors
hasGlobalErrors in interface Errorstrue if there are any global errorsErrors.hasFieldErrors()public int getGlobalErrorCount()
Errors
getGlobalErrorCount in interface ErrorsErrors.getFieldErrorCount()public ObjectError getGlobalError()
Errors
getGlobalError in interface Errorsnullpublic boolean hasFieldErrors()
Errors
hasFieldErrors in interface Errorstrue if there are any errors associated with a fieldErrors.hasGlobalErrors()public int getFieldErrorCount()
Errors
getFieldErrorCount in interface ErrorsErrors.getGlobalErrorCount()public FieldError getFieldError()
Errors
getFieldError in interface Errorsnullpublic boolean hasFieldErrors(String field)
Errors
hasFieldErrors in interface Errorsfield - the field name
true if there were any errors associated with the given fieldpublic int getFieldErrorCount(String field)
Errors
getFieldErrorCount in interface Errorsfield - the field name
public List<FieldError> getFieldErrors(String field)
ErrorsImplementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
getFieldErrors in interface Errorsfield - the field name
FieldError instancespublic FieldError getFieldError(String field)
Errors
getFieldError in interface Errorsfield - the field name
nullpublic Class getFieldType(String field)
ErrorsImplementations should be able to determine the type even
when the field value is null, for example from some
associated descriptor.
getFieldType in interface Errorsfield - the field name
null if not determinable
protected boolean isMatchingFieldError(String field,
FieldError fieldError)
field - the field that we are looking up FieldErrors forfieldError - the candidate FieldError
public String toString()
toString in class Object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||