org.sovt
Interface ValidationResult

All Known Implementing Classes:

PrefixedValidationResult, SimpleValidationResult

public interface ValidationResult

This interface is used to create and access result of SOVT validation or inspection.

There are two types of messages: messages and failures. Messages do not make validation result invalid, failures do.

Result contains messages. Messages can be set on result itself (general messages) or for a specific key (specific messages) so they can be distinguished later.

Author:

Vilmantas Baranauskas

Method Summary

void	addMessage(java.lang.String msg)
void	addMessage(java.lang.String key, java.lang.String msg) Add message for a key.
void	fail(java.lang.String msg)
void	fail(java.lang.String key, java.lang.String msg) Add failure for a key.
boolean	isValid()
boolean	isValid(java.lang.String key) Returns true if there is NO error for a key.
java.lang.String	toString()

Method Detail

addMessage

public void addMessage(java.lang.String msg)

addMessage

public void addMessage(java.lang.String key,
                       java.lang.String msg)

Add message for a key.

Parameters:

key - Key of message.

msg - message.

fail

public void fail(java.lang.String msg)

fail

public void fail(java.lang.String key,
                 java.lang.String msg)

Add failure for a key.

Parameters:

key - Key of fail message.

msg - Fail message.

isValid

public boolean isValid()

isValid

public boolean isValid(java.lang.String key)

Returns true if there is NO error for a key.

Parameters:

key - Key to check.

Returns:

true if there is NO error for a key.

toString

public java.lang.String toString()