org.dataconservancy.pass.support.messaging.cri

Class CriticalRepositoryInteraction.CriticalResult<R,T>

java.lang.Object

org.dataconservancy.pass.support.messaging.cri.CriticalRepositoryInteraction.CriticalResult<R,T>

Type Parameters:

R - the type of result

T - the type of PassEntity

Enclosing interface:

CriticalRepositoryInteraction

public static class CriticalRepositoryInteraction.CriticalResult<R,T>
extends Object

Encapsulates the result of a critical interaction with the repository.

Constructor Summary

Constructors

Constructor and Description
CriticalResult(R result, T resource, boolean success)
CriticalResult(R result, T resource, boolean success, Throwable t)

Method Summary

Modifier and Type	Method and Description
Optional<T>	resource() The state of the PassEntity resource as it was when the interaction with the repository completed.
Optional<R>	result() The result of executing the critical code path.
boolean	success() Result of evaluating the post condition of the critical path, false otherwise.
Optional<Throwable>	throwable() Captures any exception that may have occurred when executing the critical path.

Methods inherited from class java.lang.Object

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

Constructor Detail

CriticalResult

public CriticalResult(R result,
                      T resource,
                      boolean success)

CriticalResult

public CriticalResult(R result,
                      T resource,
                      boolean success,
                      Throwable t)

Method Detail

resource

public Optional<T> resource()

The state of the PassEntity resource as it was when the interaction with the repository completed. If the interaction with the repository completed without error, the Optional should not be empty.

Returns:

an Optional containing the state of the PassEntity at the end of the repository interaction

result

public Optional<R> result()

The result of executing the critical code path.

Returns:

the result of executing the critical code path

success

public boolean success()

Result of evaluating the post condition of the critical path, false otherwise.

Returns:

result of evaluating the post condition of the critical path, false otherwise.

throwable

public Optional<Throwable> throwable()

Captures any exception that may have occurred when executing the critical path.

Returns:

any exception that was caught when executing the critical path