Package ch.tocco.nice2.validate.api.result

Class AbstractValidationResult

java.lang.Object

ch.tocco.nice2.validate.api.result.AbstractValidationResult

All Implemented Interfaces:

ValidationResult

Direct Known Subclasses:

CommitValidationResult, CompleteEntityValidationResult, EntityValidationResult, FieldValidationResult

public abstract class AbstractValidationResult
extends Object
implements ValidationResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractValidationResult.Status	UNCHECKED => either not checked yet, or check skipped because others failed already. PRECONDITION_FAILED => for example a check that involves multiple fields is not executed because some information is missing; a definite check and result cannot be given at this time. this state could be used in the gui to not set the color of a field to green yet. DISABLED => for example after a warning which was suppressed, or a condition that disables it, or not checked because the value was empty. it can also mean "ignored". That might be the better name anyway. OK => check done and succeeded INFO => check done and theoretically failed but only fires an "info text". such a test cannot "fail". WARN => check done and succeeded, but a warning was issued. this may be ignored, logged, or shown to the user "are you sure?". ERROR => check done and failed

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AbstractValidationResult>	children
protected ArrayList<TextMessage>	messages
protected AbstractValidationResult.Status	status
protected Class	validatorClass
protected String	validatorName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractValidationResult()

Method Summary

Modifier and Type	Method	Description
protected String	_toString(AbstractValidationResult vRes, boolean onlyNotOkChildren)	Deprecated.
void	addChild(AbstractValidationResult child)
void	addChildAndCheckStatus(AbstractValidationResult child)	Adds the child FieldValidationResult and passes the status code up to this result if it is worse than what we currently have.
List<AbstractValidationResult>	getChildren()
String	getIndent(int tabCount)	Returns tabs to be inserted in front of text output.
ArrayList<TextMessage>	getMessages()
protected String	getName()
AbstractValidationResult.Status	getStatus()	Use the methods on the status object to find out more.
Class	getValidatorClass()
String	getValidatorName()
void	setError(TextMessage msg)	sets the status to AbstractValidationResult.Status.ERROR and sets the passed TextMessage
void	setMessage(TextMessage msg)
void	setStatus(AbstractValidationResult.Status status)
void	setValidationHint(String validationHint)	Sets a hint to be added to the log output pointing to the reason for the validation result.
void	setValidatorClass(Class validatorClass)
void	setValidatorName(String validatorName)
String	simplePrint(boolean errorsOnly)
String	toString()
String	toString(boolean onlyNotOk)	Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.validate.api.result.ValidationResult

accept

Field Details

validatorName

protected String validatorName

validatorClass

protected Class validatorClass

children

protected List<AbstractValidationResult> children

status

protected AbstractValidationResult.Status status

messages

protected ArrayList<TextMessage> messages

Constructor Details

AbstractValidationResult

protected AbstractValidationResult()

Method Details

getValidatorName

public String getValidatorName()

setValidatorName

public void setValidatorName(String validatorName)

getValidatorClass

public Class getValidatorClass()

setValidatorClass

public void setValidatorClass(Class validatorClass)

getStatus

public AbstractValidationResult.Status getStatus()

Use the methods on the status object to find out more.

setStatus

public void setStatus(AbstractValidationResult.Status status)

setError

public void setError(TextMessage msg)

sets the status to AbstractValidationResult.Status.ERROR and sets the passed TextMessage

Parameters:

msg - a text message for the error

setMessage

public void setMessage(TextMessage msg)

getMessages

public ArrayList<TextMessage> getMessages()

getChildren

public List<AbstractValidationResult> getChildren()

addChild

public void addChild(AbstractValidationResult child)

addChildAndCheckStatus

public void addChildAndCheckStatus(AbstractValidationResult child)

Adds the child FieldValidationResult and passes the status code up to this result if it is worse than what we currently have.

toString

public String toString()

Overrides:

toString in class Object

toString

@Deprecated
public String toString(boolean onlyNotOk)

Deprecated.

Parameters:

onlyNotOk - Returns only validation results that were run and ended in a not-ok status.

_toString

@Deprecated
protected String _toString(AbstractValidationResult vRes,
 boolean onlyNotOkChildren)

Deprecated.

getName

protected String getName()

simplePrint

public String simplePrint(boolean errorsOnly)

getIndent

public String getIndent(int tabCount)

Returns tabs to be inserted in front of text output.

Parameters:

tabCount - the amount of tabs to be generated

Returns:

the indent as a string of tabs

setValidationHint

public void setValidationHint(String validationHint)

Sets a hint to be added to the log output pointing to the reason for the validation result. Will be added to the output if no message was added during validation.

Parameters:

validationHint - the hint used for output

See Also:

• simplePrint(int, boolean)