org.cthul.proc

Interface Proc

All Superinterfaces:

org.hamcrest.SelfDescribing

All Known Subinterfaces:

Proc0, Proc1<A>, Proc2<A,B>, Proc3<A,B,C>, Proc4<A,B,C,D>

All Known Implementing Classes:

CurryProc, P0, P1, P2, P3, P4, PN, ProcBase, ReflectiveProc

public interface Proc
extends org.hamcrest.SelfDescribing

A proc is a piece of code that can be executed. For implementations, see ProcBase. For quick implementations in anonymous classes, see P0, P1, P2, P3, P4, and PN.

A proc is generally executed only once. The result or the exception that was thrown are cached. The only way to reset the state of a proc is with retry().

If a proc is called a new instance is created that will execute the code of the original proc, but may use different arguments.

Author:

Arian Treffer

Method Summary

Methods

Modifier and Type	Method and Description
Proc0	asProc0()
<A> Proc1<A>	asProc1()
<A,B> Proc2<A,B>	asProc2()
<A,B,C> Proc3<A,B,C>	asProc3()
<A,B,C,D> Proc4<A,B,C,D>	asProc4()
Proc	call(Object... args) Creates a new Proc that invokes the code of this Proc with args.
Proc	callAgain() Creates a new Proc that invokes the code of this Proc and uses the same arguments.
Proc	curry(Object... args)
Proc	curryAt(int i, Object... args)
Object[]	getArgs() The arguments that were used for the execution of this Proc.
Throwable	getException() Returns the exception that was thrown during execution, or null if the proc completed without error.
Object	getResult() Returns the result of the execution, or null if an exception was thrown.
boolean	hasResult() Returns true iff executing this Proc caused no exceptions.
Proc	retry() Resets the Proc.
Proc	with(Object... args) Alias for call(java.lang.Object[]).

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Method Detail

getArgs

Object[] getArgs()

The arguments that were used for the execution of this Proc.

retry

Proc retry()

Resets the Proc. The cached values are cleared, so it will be executed again.

Returns:

this object.

callAgain

Proc callAgain()

Creates a new Proc that invokes the code of this Proc and uses the same arguments.

Returns:

new Proc

call

Proc call(Object... args)

Creates a new Proc that invokes the code of this Proc with args.

Parameters:

args -

Returns:

new Proc

with

Proc with(Object... args)

Alias for call(java.lang.Object[]).

See Also:

call(java.lang.Object[])

hasResult

boolean hasResult()

Returns true iff executing this Proc caused no exceptions.

If true, getResult() can be called to retrieve the result of the execution. Otherwise, getException() will return the exception that was thrown.

Returns:

if this Proc returned.

getResult

Object getResult()

Returns the result of the execution, or null if an exception was thrown.

Returns:

result

getException

Throwable getException()

Returns the exception that was thrown during execution, or null if the proc completed without error.

Returns:

exception

curry

Proc curry(Object... args)

curryAt

Proc curryAt(int i,
           Object... args)

asProc0

Proc0 asProc0()

asProc1

<A> Proc1<A> asProc1()

asProc2

<A,B> Proc2<A,B> asProc2()

asProc3

<A,B,C> Proc3<A,B,C> asProc3()

asProc4

<A,B,C,D> Proc4<A,B,C,D> asProc4()