Module de.mlo.dev.validation

Package de.mlo.dev.validation

Class ValidationResult

java.lang.Object

de.mlo.dev.validation.ValidationResult

All Implemented Interfaces:

Iterable<ValidationInfo>

public class ValidationResult
extends Object
implements Iterable<ValidationInfo>

Author:

mlo

Field Summary

Fields

Modifier and Type	Field	Description
static String	LINE_SEPARATOR	The system line separator

Constructor Summary

Constructors

Constructor	Description
ValidationResult()

Method Summary

Modifier and Type	Method	Description
ValidationResult	add(ValidationInfo validationInfo)	Adds a new ValidationInfo at the end of the list.
ValidationResult	add(ValidationInfo first, ValidationInfo... more)	Adds one or more ValidationInfos at the end of the list
ValidationResult	add(ValidationResult validationResult)	Merges the given ValidationResult into this result.
ValidationResult	add(Collection<ValidationInfo> validationInfos)	Adds a bunch of ValidationInfos at the end of the list
List<ValidationInfo>	getInfos()
String	getMessage()
String	getMessage(String delimiter)
List<String>	getMessages()
static ValidationResult	invalid(String message)	Convenient function: Creates a ValidationResult with on ValidationInfo which is invalid and contains the given message. Caution: If a process combines results the end result will be invalid.
boolean	isInvalid()
boolean	isValid()
Iterator<ValidationInfo>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LINE_SEPARATOR

public static final String LINE_SEPARATOR

The system line separator

Constructor Detail

ValidationResult

public ValidationResult()

Method Detail

invalid

public static ValidationResult invalid(String message)

Convenient function: Creates a ValidationResult with on ValidationInfo which is invalid and contains the given message.
Caution: If a process combines results the end result will be invalid.

Parameters:

message - A description why the result is invalid

Returns:

A new instance of a ValidationResult

add

public ValidationResult add(ValidationResult validationResult)

Merges the given ValidationResult into this result. The given result object is not touched. The ValidationInfos from the given container are transferred to this container.

Parameters:

validationResult - An already existent result container

Returns:

An instance of this ValidationResult

add

public ValidationResult add(ValidationInfo first,
                            ValidationInfo... more)

Adds one or more ValidationInfos at the end of the list

Parameters:

first - Single information about the validation process

more - A list of information about the validation process

Returns:

An instance of this ValidationResult

add

public ValidationResult add(Collection<ValidationInfo> validationInfos)

Adds a bunch of ValidationInfos at the end of the list

Parameters:

validationInfos - A list of information about the validation process

Returns:

An instance of this ValidationResult

add

public ValidationResult add(ValidationInfo validationInfo)

Adds a new ValidationInfo at the end of the list.

Parameters:

validationInfo - Single information about the validation process

Returns:

An instance of this ValidationResult

isValid

public boolean isValid()

Returns:

true if all ValidationInfos are valid

isInvalid

public boolean isInvalid()

Returns:

true if one of the ValidationInfos is invalid

getInfos

public List<ValidationInfo> getInfos()

Returns:

All added ValidationInfo. The order is maintained.

getMessage

public String getMessage()

Returns:

A combined message from all ValidationInfos. The messages are separated by the system default line separator

getMessage

public String getMessage(String delimiter)

Parameters:

delimiter - A custom delimiter which is inserted between messages

Returns:

A combined message from all ValidationInfos. The messages are separated by the given delimiter

getMessages

public List<String> getMessages()

Returns:

A list of all messages from the ValidationInfos.

iterator

public Iterator<ValidationInfo> iterator()

Specified by:

iterator in interface Iterable<ValidationInfo>