com.google.gdata.model

Class ValidationContext

java.lang.Object

com.google.gdata.model.ValidationContext

public class ValidationContext
extends Object

Data structure used to accumulate data model validation errors.

would be used as follows:

   public interface Validatable {
     public static class ValidationContext { ... }
     public boolean validate(ValidationContext vc);
   }

   public class Element implements Validatable { ... }
 

Then we could eventually reuse the context class and the accumulation model in other places (attribute validation? metadata validation?). In that case, we might want to make the 1st arg of addError more generic (like 'Object relatedTo') or something.

Constructor Summary

Constructors

Constructor and Description
ValidationContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(Element element, ErrorContent error) Add a validation error to list.
void	addError(Element element, String error) Add an error by error string.
Map<Element,List<ErrorContent>>	getErrors()
boolean	isValid()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationContext

public ValidationContext()

Method Detail

getErrors

public Map<Element,List<ErrorContent>> getErrors()

Returns:

map of validation errors

addError

public void addError(Element element,
            String error)

Add an error by error string. This will register an error in the core gdata domain with an error code of "invalidElement" and the internal reason set to the given error string. For a more useful error message, addError(Element, ErrorContent) should be used instead.

addError

public void addError(Element element,
            ErrorContent error)

Add a validation error to list.

Parameters:

element - element that was found to be invalid

error - error message

isValid

public boolean isValid()

Returns:

true if instance data is valid

toString

public String toString()

Overrides:

toString in class Object