org.cyclopsgroup.jcli

Class ValidationResult

java.lang.Object

org.cyclopsgroup.jcli.ValidationResult

public final class ValidationResult
extends Object

Argument validation result coming from ArgumentProcessor.validate(String[])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationResult.ArgumentMissing A violation indicating required argument is missing
static class	ValidationResult.OptionMissing Type of violation where a required option is missing
static class	ValidationResult.UnexpectedOption Violation where an unexpected option value is found
static class	ValidationResult.Violation A validation violation

Constructor Summary

Constructors

Constructor and Description
ValidationResult()

Method Summary

Modifier and Type	Method and Description
<T extends ValidationResult.Violation> void	addViolation(T violation) Add a new violation to validation result
List<ValidationResult.Violation>	getViolations() Get list of violations in result
boolean	isValid()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationResult

public ValidationResult()

Method Detail

addViolation

public <T extends ValidationResult.Violation> void addViolation(T violation)

Add a new violation to validation result

Type Parameters:

T - Type of validation violation

Parameters:

violation - Violation

getViolations

public List<ValidationResult.Violation> getViolations()

Get list of violations in result

Returns:

List of violations in result

isValid

public boolean isValid()

Returns:

True if there is not violation