net.sf.doolin.gui.validation
Class GUIValidation

java.lang.Object
  extended by net.sf.doolin.gui.validation.GUIValidation

public class GUIValidation
extends Object

This class defines the result for a validation. It is mainly a list of GUIValidationMessage instances.

Author:
Damien Coraboeuf

Field Summary
static GUIValidation EMPTY
          Empty (valid) validation object.
 
Constructor Summary
GUIValidation()
           
 
Method Summary
 void addAllFrom(GUIValidation subResults)
          Merge the subResults to this validation object.
 void addMessage(GUIValidationMessage message)
          Adds a validation message
 void addMessage(Object key, String msgKey, Object... params)
          Adds a validation message
 List<GUIValidationMessage> getMessages()
          Gets the list of messages
 boolean hasErrors()
          Checks if this GUIValidation object has errors.
 boolean isValid()
          Checks if this GUIValidation object is valid.
 Map<Object,GUIValidation> keyMap()
          Returns a map of validations objects, indexed by field keys.
static GUIValidation unmodifiable(GUIValidation source)
          Returns an unmodifiable version of the given GUIValidation instance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY

public static final GUIValidation EMPTY
Empty (valid) validation object.

Constructor Detail

GUIValidation

public GUIValidation()
Method Detail

addMessage

public void addMessage(GUIValidationMessage message)
Adds a validation message

Parameters:
message - Message to add

addMessage

public void addMessage(Object key,
                       String msgKey,
                       Object... params)
Adds a validation message

Parameters:
key - Key of the field
msgKey - Text key for the displayed message
params - Parameters for the displayed message
See Also:
GUIValidationMessage.GUIValidationMessage(Object, String, Object...)

getMessages

public List<GUIValidationMessage> getMessages()
Gets the list of messages

Returns:
List of messages

isValid

public boolean isValid()
Checks if this GUIValidation object is valid. It is valid if the list of messages is empty.

Returns:
true if valid

hasErrors

public boolean hasErrors()
Checks if this GUIValidation object has errors.

Returns:
true if this validation has errors
See Also:
isValid()

addAllFrom

public void addAllFrom(GUIValidation subResults)
Merge the subResults to this validation object.

Parameters:
subResults - GUIValidation to merge

unmodifiable

public static GUIValidation unmodifiable(GUIValidation source)
Returns an unmodifiable version of the given GUIValidation instance

Parameters:
source - Source object
Returns:
Unmodifiable object

keyMap

public Map<Object,GUIValidation> keyMap()
Returns a map of validations objects, indexed by field keys.

Returns:
Map of validations objects, indexed by field keys


Copyright © 2011. All Rights Reserved.