Java Doc for Errors.java in  » J2EE » spring-framework-2.0.6 » org » springframework » validation » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.validation 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.springframework.validation.Errors

All known Subclasses:   org.springframework.web.bind.EscapedErrors,
Errors
public interface Errors (Code)
Stores and exposes information about data-binding and validation errors for a specific object.

Field names can be properties of the target object (e.g. "name" when binding to a customer object), or nested fields in case of subobjects (e.g. "address.street"). Supports subtree navigation via Errors.setNestedPath(String) : for example, an AddressValidator validates "address", not being aware that this is a subobject of customer.

Note: Errors objects are single-threaded.
author:
   Rod Johnson
author:
   Juergen Hoeller
See Also:   Errors.setNestedPath
See Also:   BindException
See Also:   DataBinder
See Also:   ValidationUtils



Field Summary
 StringNESTED_PATH_SEPARATOR
     The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street".


Method Summary
 voidaddAllErrors(Errors errors)
     Add all errors from the given Errors instance to this Errors instance.
 ListgetAllErrors()
     Get all errors, both global and field ones.
 intgetErrorCount()
     Return the total number of errors.
 FieldErrorgetFieldError()
     Get the first error associated with a field, if any.
 FieldErrorgetFieldError(String field)
     Get the first error associated with the given field, if any.
 intgetFieldErrorCount()
     Return the number of errors associated with a field.
 intgetFieldErrorCount(String field)
     Return the number of errors associated with the given field.
 ListgetFieldErrors()
     Get all errors associated with a field.
 ListgetFieldErrors(String field)
     Get all errors associated with the given field.
 ClassgetFieldType(String field)
     Return the type of a given field.
 ObjectgetFieldValue(String field)
     Return the current value of the given field, either the current bean property value or a rejected update from the last binding.
 ObjectErrorgetGlobalError()
     Get the first global error, if any.
 intgetGlobalErrorCount()
     Return the number of global errors.
 ListgetGlobalErrors()
     Get all global errors.
 StringgetNestedPath()
     Return the current nested path of this Errors object.

Returns a nested path with a dot, i.e.

 StringgetObjectName()
     Return the name of the bound root object.
 booleanhasErrors()
     Return if there were any errors.
 booleanhasFieldErrors()
    
 booleanhasFieldErrors(String field)
    
 booleanhasGlobalErrors()
    
 voidpopNestedPath()
     Pop the former nested path from the nested path stack.
 voidpushNestedPath(String subPath)
     Push the given sub path onto the nested path stack.
 voidreject(String errorCode)
     Register a global error for the entire target object, using the given error description.
 voidreject(String errorCode, String defaultMessage)
     Register a global error for the entire target object, using the given error description.
 voidreject(String errorCode, Object[] errorArgs, String defaultMessage)
     Register a global error for the entire target object, using the given error description.
 voidrejectValue(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.

The field name may be null or empty String to indicate the current object itself rather than a field of it.

 voidrejectValue(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.

The field name may be null or empty String to indicate the current object itself rather than a field of it.

 voidrejectValue(String field, String errorCode, Object[] errorArgs, 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.

The field name may be null or empty String to indicate the current object itself rather than a field of it.

 voidsetNestedPath(String nestedPath)
     Allow context to be changed so that standard validators can validate subtrees.

Field Detail
NESTED_PATH_SEPARATOR
String NESTED_PATH_SEPARATOR(Code)
The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street".

"." = same as the org.springframework.beans.PropertyAccessor.NESTED_PROPERTY_SEPARATOR nested property separator in the beans package.






Method Detail
addAllErrors
void addAllErrors(Errors errors)(Code)
Add all errors from the given Errors instance to this Errors instance.

This is a onvenience method to avoid repeated reject(..) calls for merging an Errors instance into another Errors instance.

Note that the passed-in Errors instance is supposed to refer to the same target object, or at least contain compatible errors that apply to the target object of this Errors instance.
Parameters:
  errors - the Errors instance to merge in




getAllErrors
List getAllErrors()(Code)
Get all errors, both global and field ones. List of ObjectError instances



getErrorCount
int getErrorCount()(Code)
Return the total number of errors.



getFieldError
FieldError getFieldError()(Code)
Get the first error associated with a field, if any. the field-specific error, or null



getFieldError
FieldError getFieldError(String field)(Code)
Get the first error associated with the given field, if any.
Parameters:
  field - the field name the field-specific error, or null



getFieldErrorCount
int getFieldErrorCount()(Code)
Return the number of errors associated with a field. the number of errors associated with a field
See Also:   Errors.getGlobalErrorCount()
See Also:   



getFieldErrorCount
int getFieldErrorCount(String field)(Code)
Return the number of errors associated with the given field.
Parameters:
  field - the field name the number of errors associated with the given field



getFieldErrors
List getFieldErrors()(Code)
Get all errors associated with a field. a List of FieldError instances



getFieldErrors
List getFieldErrors(String field)(Code)
Get all errors associated with the given field.

Implementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
Parameters:
  field - the field name a List of FieldError instances




getFieldType
Class getFieldType(String field)(Code)
Return the type of a given field.

Implementations should be able to determine the type even when the field value is null, for example from some associated descriptor.
Parameters:
  field - the field name the type of the field, or null if not determinable




getFieldValue
Object getFieldValue(String field)(Code)
Return the current value of the given field, either the current bean property value or a rejected update from the last binding.

Allows for convenient access to user-specified field values, even if there were type mismatches.
Parameters:
  field - the field name the current value of the given field




getGlobalError
ObjectError getGlobalError()(Code)
Get the first global error, if any. the global error, or null



getGlobalErrorCount
int getGlobalErrorCount()(Code)
Return the number of global errors. the number of global errors
See Also:   Errors.getFieldErrorCount()
See Also:   



getGlobalErrors
List getGlobalErrors()(Code)
Get all global errors. List of ObjectError instances



getNestedPath
String getNestedPath()(Code)
Return the current nested path of this Errors object.

Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.




getObjectName
String getObjectName()(Code)
Return the name of the bound root object.



hasErrors
boolean hasErrors()(Code)
Return if there were any errors.



hasFieldErrors
boolean hasFieldErrors()(Code)
Are there any field errors? true if there are any errors associated with a field
See Also:   Errors.hasGlobalErrors()
See Also:   



hasFieldErrors
boolean hasFieldErrors(String field)(Code)
Are there any errors associated with the given field?
Parameters:
  field - the field name true if there were any errors associated with the given field



hasGlobalErrors
boolean hasGlobalErrors()(Code)
Are there any global errors? true if there are any global errors
See Also:   Errors.hasFieldErrors()
See Also:   



popNestedPath
void popNestedPath() throws IllegalStateException(Code)
Pop the former nested path from the nested path stack.
throws:
  IllegalStateException - if there is no former nested path on the stack
See Also:   Errors.pushNestedPath



pushNestedPath
void pushNestedPath(String subPath)(Code)
Push the given sub path onto the nested path stack.

A 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.
Parameters:
  subPath - the sub path to push onto the nested path stack
See Also:   Errors.popNestedPath




reject
void reject(String errorCode)(Code)
Register a global error for the entire target object, using the given error description.
Parameters:
  errorCode - error code, interpretable as a message key



reject
void reject(String errorCode, String defaultMessage)(Code)
Register a global error for the entire target object, using the given error description.
Parameters:
  errorCode - error code, interpretable as a message key
Parameters:
  defaultMessage - fallback default message



reject
void reject(String errorCode, Object[] errorArgs, String defaultMessage)(Code)
Register a global error for the entire target object, using the given error description.
Parameters:
  errorCode - error code, interpretable as a message key
Parameters:
  errorArgs - error arguments, for argument binding via MessageFormat(can be null)
Parameters:
  defaultMessage - fallback default message



rejectValue
void rejectValue(String field, String errorCode)(Code)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.

The 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.
Parameters:
  field - the field name (may be null or empty String)
Parameters:
  errorCode - error code, interpretable as a message key
See Also:   Errors.getNestedPath()




rejectValue
void rejectValue(String field, String errorCode, String defaultMessage)(Code)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.

The 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.
Parameters:
  field - the field name (may be null or empty String)
Parameters:
  errorCode - error code, interpretable as a message key
Parameters:
  defaultMessage - fallback default message
See Also:   Errors.getNestedPath()




rejectValue
void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage)(Code)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.

The 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.
Parameters:
  field - the field name (may be null or empty String)
Parameters:
  errorCode - error code, interpretable as a message key
Parameters:
  errorArgs - error arguments, for argument binding via MessageFormat(can be null)
Parameters:
  defaultMessage - fallback default message
See Also:   Errors.getNestedPath()




setNestedPath
void setNestedPath(String nestedPath)(Code)
Allow context to be changed so that standard validators can validate subtrees. Reject calls prepend the given path to the field names.

For example, an address validator could validate the subobject "address" of a customer object.
Parameters:
  nestedPath - 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.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.