Package org.shakespeareframework

Class Actor

java.lang.Object

org.shakespeareframework.Actor

@NullMarked
public final class Actor
extends Object

An Actor is the central class of the Shakespeare Framework. It is basically used for any interaction with the system under test.

Constructor Summary

Constructors

Constructor	Description
Actor()	Picks a name from NAMES.
Actor(String name)

Method Summary

Modifier and Type	Method	Description
Actor	can(Ability... abilities)
<A> A	checks(Question<A> question)
<A> A	checks(RetryableQuestion<A> question)
Actor	does(RetryableTask task)
Actor	does(Task task)
boolean	equals(Object obj)
String	getName()
int	hashCode()
Actor	informs(Reporter... reporters)
Actor	learns(Fact... facts)
<F extends Fact> F	remembers(Class<F> factClass)
String	toString()
<A extends Ability> A	uses(Class<A> abilityClass)

Methods inherited from class java.lang.Object

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

Constructor Details

Actor

public Actor(String name)

Parameters:

name - a name used for logging and reporting

Actor

public Actor()

Picks a name from NAMES.

Method Details

does

public Actor does(Task task)

Parameters:

task - the Task to be performed by this Actor

Returns:

this Actor

does

public Actor does(RetryableTask task)

Parameters:

task - the RetryableTask to be performed by this Actor

Returns:

this Actor

Throws:

TimeoutException - if no acceptable answer is given when the question's timeout is reached

checks

public <A> A checks(Question<A> question)

Type Parameters:

A - the Class of the answer

Parameters:

question - the Question to be answered by this Actor

Returns:

the answer to the given Question

checks

public <A> A checks(RetryableQuestion<A> question)

Type Parameters:

A - the Class of the answer

Parameters:

question - the RetryableQuestion to be answered by this Actor

Returns:

the answer to the given Question

Throws:

TimeoutException - if no acceptable answer is given when the question's timeout is reached

can

public Actor can(Ability... abilities)

Parameters:

abilities - Abilitys the Actor may uses(java.lang.Class<A>)

Returns:

this Actor

uses

public <A extends Ability> A uses(Class<A> abilityClass)

Type Parameters:

A - the required Ability Class

Parameters:

abilityClass - the Ability Class that should be used

Returns:

the Ability instance from the Actor's abilities

Throws:

MissingAbilityException - if there's no instance of the requested Ability Class in the Actor's abilities

learns

public Actor learns(Fact... facts)

Parameters:

facts - Facts the Actor remembers(java.lang.Class<F>)s

Returns:

this Actor

remembers

public <F extends Fact> F remembers(Class<F> factClass)

Type Parameters:

F - the required Fact Class

Parameters:

factClass - the Fact Class that should be remembered

Returns:

the Fact instance for the Actor's facts

Throws:

MissingFactException - if there's no instance of the requested Fact Class in the Actor's facts

informs

public Actor informs(Reporter... reporters)

Parameters:

reporters - Reporters that should be informed in the order they should be informed

Returns:

this Actor

getName

public String getName()

Returns:

name

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object