org.cthul.proc

Class ProcBase<This extends ProcBase<This>>

java.lang.Object

org.cthul.proc.ProcBase<This>

Type Parameters:

This -

All Implemented Interfaces:

Proc, org.hamcrest.SelfDescribing

Direct Known Subclasses:

P0, P1, P2, P3, P4, PN

public abstract class ProcBase<This extends ProcBase<This>>
extends Object
implements Proc

Impements the basic contract of the Proc interface, but has no behavior.

See Also:

P0, P1, P2, P3, P4, PN

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object[]	NO_ARGS
protected ProcBase	source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcBase()
protected	ProcBase(Object... args)
protected	ProcBase(ProcBase source) Creates a ProcBase that uses the run-method of source instead of its own.
protected	ProcBase(ProcBase source, Object... args)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	args(Object... args) Sets the arguments, for internal use only.
P0	asProc0()
<A> P1<A>	asProc1()
<A,B> P2<A,B>	asProc2()
<A,B,C> P3<A,B,C>	asProc3()
<A,B,C,D> P4<A,B,C,D>	asProc4()
protected void	assertArgCount(Object[] args, int count) Throws a ProcError exception if {@code args.length !
This	call(Object... args) Creates a new Proc that invokes the code of this Proc with args.
This	callAgain() Creates a new Proc that invokes the code of this Proc and uses the same arguments.
protected This	copy()
protected This	copy(Object... args)
protected abstract This	createCopy(Object[] args)
Proc	curry(Object... args)
Proc	curryAt(int i, Object... args)
protected int	describeArgsTo(org.hamcrest.Description description) Describes the arguments that are used for execution this asProc.
protected void	describeKeyTo(org.hamcrest.Description description)
protected void	describeNameTo(org.hamcrest.Description description)
void	describeTo(org.hamcrest.Description description)
protected ProcError	exception(Class<? extends RuntimeException> reClazz, String message, Throwable cause)
protected Object	executeProc(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.
protected ProcError	illegalArgumentException(String message)
protected void	name(String name) Sets the name of this proc.
protected UnsupportedOperationException	notImplemented(String method)
This	retry() Resets the Proc.
protected abstract Object	run(Object[] args) Execute the proc.
protected ProcError	runtimeException(String message)
protected ProcError	runtimeException(String message, Throwable cause)
String	toString()
This	with(Object... args) Alias for Proc.call(java.lang.Object[]).

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGS

protected static final Object[] NO_ARGS

source

protected final ProcBase source

Constructor Detail

ProcBase

protected ProcBase()

ProcBase

protected ProcBase(Object... args)

ProcBase

protected ProcBase(ProcBase source)

Creates a ProcBase that uses the run-method of source instead of its own.

Parameters:

source -

ProcBase

protected ProcBase(ProcBase source,
        Object... args)

Method Detail

args

protected final void args(Object... args)

Sets the arguments, for internal use only.

Parameters:

args -

getArgs

public Object[] getArgs()

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

Specified by:

getArgs in interface Proc

name

protected final void name(String name)

Sets the name of this proc. It will be used as description and has no functional purpose.

Parameters:

name -

assertArgCount

protected void assertArgCount(Object[] args,
                  int count)

Throws a ProcError exception if args.length != count

Parameters:

args -

count -

notImplemented

protected UnsupportedOperationException notImplemented(String method)

run

protected abstract Object run(Object[] args)
                       throws Throwable

Execute the proc.

Returns:

result

Throws:

Throwable

copy

protected This copy()

copy

protected This copy(Object... args)

createCopy

protected abstract This createCopy(Object[] args)

retry

public This retry()

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

Specified by:

retry in interface Proc

Returns:

this object.

executeProc

protected Object executeProc(Object... args)
                      throws Throwable

Throws:

Throwable

callAgain

public This callAgain()

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

Specified by:

callAgain in interface Proc

Returns:

new Proc

call

public This call(Object... args)

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

Specified by:

call in interface Proc

Returns:

new Proc

with

public This with(Object... args)

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

Specified by:

with in interface Proc

See Also:

Proc.call(java.lang.Object[])

hasResult

public boolean hasResult()

Returns true iff executing this Proc caused no exceptions.

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

Specified by:

hasResult in interface Proc

Returns:

if this Proc returned.

getResult

public Object getResult()

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

Specified by:

getResult in interface Proc

Returns:

result

getException

public Throwable getException()

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

Specified by:

getException in interface Proc

Returns:

exception

asProc0

public P0 asProc0()

Specified by:

asProc0 in interface Proc

asProc1

public <A> P1<A> asProc1()

Specified by:

asProc1 in interface Proc

asProc2

public <A,B> P2<A,B> asProc2()

Specified by:

asProc2 in interface Proc

asProc3

public <A,B,C> P3<A,B,C> asProc3()

Specified by:

asProc3 in interface Proc

asProc4

public <A,B,C,D> P4<A,B,C,D> asProc4()

Specified by:

asProc4 in interface Proc

curry

public Proc curry(Object... args)

Specified by:

curry in interface Proc

curryAt

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

Specified by:

curryAt in interface Proc

describeTo

public void describeTo(org.hamcrest.Description description)

Specified by:

describeTo in interface org.hamcrest.SelfDescribing

describeKeyTo

protected void describeKeyTo(org.hamcrest.Description description)

describeNameTo

protected void describeNameTo(org.hamcrest.Description description)

describeArgsTo

protected int describeArgsTo(org.hamcrest.Description description)

Describes the arguments that are used for execution this asProc.

Parameters:

description -

toString

public String toString()

Overrides:

toString in class Object

exception

protected ProcError exception(Class<? extends RuntimeException> reClazz,
                  String message,
                  Throwable cause)

runtimeException

protected ProcError runtimeException(String message)

runtimeException

protected ProcError runtimeException(String message,
                         Throwable cause)

illegalArgumentException

protected ProcError illegalArgumentException(String message)