org.apache.commons.validator

Class ValidatorResults

java.lang.Object

org.apache.commons.validator.ValidatorResults

All Implemented Interfaces:

java.io.Serializable

public class ValidatorResults
extends java.lang.Object
implements java.io.Serializable

This contains the results of a set of validation rules processed on a JavaBean.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	hResults Map of validation results.

Constructor Summary

Constructors

Constructor and Description
ValidatorResults()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Field field, java.lang.String validatorName, boolean result) Add a the result of a validator action.
void	add(Field field, java.lang.String validatorName, boolean result, java.lang.Object value) Add a the result of a validator action.
void	clear() Clear all results recorded by this object.
boolean	empty() Deprecated. Use isEmpty() instead.
java.util.Iterator	get() Deprecated. Use getPropertyNames() instead.
java.util.Set	getPropertyNames() Return the set of property names for which at least one message has been recorded.
java.util.Map	getResultValueMap() Get a Map of any Objects returned from validation routines.
ValidatorResult	getValidatorResult(java.lang.String key) Gets the ValidatorResult associated with the key passed in.
boolean	isEmpty() Return true if there are no messages recorded in this collection, or false otherwise.
void	merge(ValidatorResults results) Merge another ValidatorResults into mine.
java.util.Iterator	properties() Deprecated. Use getPropertyNames() instead.

Methods inherited from class java.lang.Object

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

Field Detail

hResults

protected java.util.Map hResults

Map of validation results.

Constructor Detail

ValidatorResults

public ValidatorResults()

Method Detail

merge

public void merge(ValidatorResults results)

Merge another ValidatorResults into mine.

add

public void add(Field field,
       java.lang.String validatorName,
       boolean result)

Add a the result of a validator action.

add

public void add(Field field,
       java.lang.String validatorName,
       boolean result,
       java.lang.Object value)

Add a the result of a validator action.

clear

public void clear()

Clear all results recorded by this object.

empty

public boolean empty()

Deprecated. Use isEmpty() instead.

Return true if there are no messages recorded in this collection, or false otherwise.

isEmpty

public boolean isEmpty()

Return true if there are no messages recorded in this collection, or false otherwise.

getValidatorResult

public ValidatorResult getValidatorResult(java.lang.String key)

Gets the ValidatorResult associated with the key passed in. The key the ValidatorResult is stored under is the Field's getKey method.

Parameters:

key - The key generated from Field (this is often just the field name).

get

public java.util.Iterator get()

Deprecated. Use getPropertyNames() instead.

Return the set of all recorded messages, without distinction by which property the messages are associated with. If there are no messages recorded, an empty enumeration is returned.

properties

public java.util.Iterator properties()

Deprecated. Use getPropertyNames() instead.

Return the set of property names for which at least one message has been recorded. If there are no messages, an empty Iterator is returned. If you have recorded global messages, the String value of ActionMessages.GLOBAL_MESSAGE will be one of the returned property names.

getPropertyNames

public java.util.Set getPropertyNames()

Return the set of property names for which at least one message has been recorded.

Returns:

An unmodifiable Set of the property names.

getResultValueMap

public java.util.Map getResultValueMap()

Get a Map of any Objects returned from validation routines.