Package org.yamcs.commanding

Class VerificationResult

java.lang.Object

org.yamcs.commanding.VerificationResult

public class VerificationResult
extends Object

Class that can be used to capture the outcome of a verifier execution.

Field Summary

Fields

Modifier and Type	Field	Description
static final VerificationResult	FAIL
String	message	Optional message explaining why the command is successful or not (like an error message).
Object	returnValue	An optional return value.
boolean	success	Overall result of this verifier (success/fail).
static final VerificationResult	SUCCESS

Constructor Summary

Constructors

Constructor	Description
VerificationResult(boolean success)
VerificationResult(boolean success, String message)
VerificationResult(boolean success, String message, Object returnValue)

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SUCCESS

public static final VerificationResult SUCCESS

FAIL

public static final VerificationResult FAIL

success

public boolean success

Overall result of this verifier (success/fail).

This impacts the acknowledgment status (green/red).

message

public String message

Optional message explaining why the command is successful or not (like an error message).

returnValue

public Object returnValue

An optional return value. This may be given either on success or fail.

If a verifier is configured to complete the command, the return value of the verifier can become the return value of the command itself.

This value will be transformed into a Value, unless it already is of that type.

Constructor Details

VerificationResult

public VerificationResult(boolean success)

VerificationResult

public VerificationResult(boolean success,
 String message)

VerificationResult

public VerificationResult(boolean success,
 String message,
 Object returnValue)

Method Details

toString

public String toString()

Overrides:

toString in class Object