Package com.privatechain.core.spi

Class ValidationResult

java.lang.Object

com.privatechain.core.spi.ValidationResult

public final class ValidationResult
extends Object

Immutable result returned by TransactionValidator.validate(com.privatechain.core.model.Transaction, com.privatechain.core.builder.Blockchain).

A result is either successful or failed. On failure, it carries a non-empty list of human-readable error messages and a ValidationResult.ValidationStatus classifying the failure category (FR-TX-02).

Factory methods success(), failure(ValidationStatus, String), and failure(ValidationStatus, List) cover the common construction patterns.

 // In a validator implementation:
 if (!signatureOk) {
     return ValidationResult.failure(
         ValidationStatus.INVALID_SIGNATURE,
         "Signature does not match sender public key");
 }
 return ValidationResult.success();
 

Since:

1.0.0

See Also:

• TransactionValidator
• ValidationResult.ValidationStatus

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidationResult.ValidationStatus	Classification of a transaction validation outcome.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ValidationResult	failure(ValidationResult.ValidationStatus status, String message)	Creates a failed result with a single error message.
static ValidationResult	failure(ValidationResult.ValidationStatus status, List<String> errors)	Creates a failed result with multiple error messages.
List<String>	getErrors()	Returns the list of human-readable error descriptions.
ValidationResult.ValidationStatus	getStatus()	Returns the status classification of the validation outcome.
int	hashCode()
boolean	isFailure()	Returns true if the transaction failed one or more validation checks.
boolean	isSuccess()	Returns true if the transaction passed all validation checks.
static ValidationResult	success()	Returns the canonical singleton representing a successful validation.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

success

public static ValidationResult success()

Returns the canonical singleton representing a successful validation.

Returns:

a ValidationResult with success=true and ValidationResult.ValidationStatus.VALID

failure

public static ValidationResult failure(ValidationResult.ValidationStatus status,
 String message)

Creates a failed result with a single error message.

Parameters:

status - classification of the failure (non-null, must not be ValidationResult.ValidationStatus.VALID)

message - human-readable error description (non-null, non-blank)

Returns:

a failed ValidationResult

Throws:

NullPointerException - if status or message is null

IllegalArgumentException - if status is ValidationResult.ValidationStatus.VALID or message is blank

failure

public static ValidationResult failure(ValidationResult.ValidationStatus status,
 List<String> errors)

Creates a failed result with multiple error messages.

Parameters:

status - classification of the failure (non-null, must not be ValidationResult.ValidationStatus.VALID)

errors - list of human-readable error descriptions (non-null, non-empty)

Returns:

a failed ValidationResult

Throws:

NullPointerException - if status or errors is null

IllegalArgumentException - if status is ValidationResult.ValidationStatus.VALID or errors is empty

isSuccess

public boolean isSuccess()

Returns true if the transaction passed all validation checks.

Returns:

true on success

isFailure

public boolean isFailure()

Returns true if the transaction failed one or more validation checks.

Returns:

true on failure

getStatus

public ValidationResult.ValidationStatus getStatus()

Returns the status classification of the validation outcome.

Returns:

ValidationResult.ValidationStatus.VALID on success, or a failure enum value

getErrors

public List<String> getErrors()

Returns the list of human-readable error descriptions.

Returns:

unmodifiable list; empty on success, non-empty on failure

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object