com.github.pnavais.machine.api.validator

Class ValidationResult

java.lang.Object

com.github.pnavais.machine.api.validator.ValidationResult

public class ValidationResult
extends Object

This class holds the results of a validation with an optional detailed description message and companion exception class.

Constructor Summary

Constructors

Constructor and Description
ValidationResult()

Method Summary

Modifier and Type	Method and Description
static ValidationResult	fail(String message) Creates an unsuccessful validation result with the given message.
static ValidationResult	from(@NonNull RuntimeException e) Creates an invalid result from a given exception
static ValidationResult	success() Creates a successful validation result

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

from

public static ValidationResult from(@NonNull
                                    @NonNull RuntimeException e)

Creates an invalid result from a given exception

Parameters:

e - the exception

Returns:

the validation result

success

public static ValidationResult success()

Creates a successful validation result

Returns:

successful validation result

fail

public static ValidationResult fail(String message)

Creates an unsuccessful validation result with the given message.

Parameters:

message - the message.

Returns:

unsuccessful validation result