Module com.serenitybdd.serenityscreenplay

Package net.serenitybdd.screenplay

Class Actor

java.lang.Object

net.serenitybdd.screenplay.Actor

All Implemented Interfaces:

net.serenitybdd.core.parallel.Agent, net.serenitybdd.core.SkipNested, PerformsTasks

public class Actor
extends Object
implements PerformsTasks, net.serenitybdd.core.SkipNested, net.serenitybdd.core.parallel.Agent

An actor represents the person or system using the application under test. Actors can have Abilities, which allows them to perform Tasks and Interactions. Actors can ask Questions about the state of the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Actor.ErrorHandlingMode

Field Summary

Fields inherited from interface net.serenitybdd.core.parallel.Agent

IN_THE_CURRENT_SESSION

Constructor Summary

Constructors

Constructor	Description
Actor(String name)

Method Summary

Modifier and Type	Method	Description
<T extends Ability> T	abilityTo(Class<? extends T> doSomething)
<ANSWER> ANSWER	asksFor(Question<ANSWER> question)
void	assignDescriptionToActor(String description)
void	assignName(String name)
final void	attemptsTo(Actor.ErrorHandlingMode mode, Performable... tasks)
final void	attemptsTo(Performable... tasks)
void	brief(Actor otherActor)	Add all the remembered items for the current actor to the other actor's memory
final void	can(Consequence<?>... consequences)
<T extends Ability> Actor	can(T doSomething)
Actor	describedAs(String description)
final void	entersTheScene()	A method used to declare that an actor is now the actor in the spotlight, without having them perform any tasks.
<T> T	forget(String key)
<T> T	gaveAsThe(String key)
<C> C	getAbilityThatExtends(Class<C> extendedClass)	Return an ability that extends the given class.
String	getDescription()
String	getId()
String	getName()
String	getNameOrPronoun()
List<HasTeardown>	getTeardowns()	Return a list of all Abilitys which implement HasTeardown
final void	has(Fact... facts)
final void	has(Performable... todos)
static Actor	named(String name)	Create a new actor with a given name.
<T> T	recall(String key)
Map<String,Object>	recallAll()
void	remember(String key, Object value)
<ANSWER> void	remember(String key, Question<ANSWER> question)
<T> T	sawAsThe(String key)
final void	should(String groupStepName, Consequence<?>... consequences)
final void	should(List<Consequence<?>> consequences)
final void	should(Consequence<?>... consequences)
String	toString()
<T extends Ability> T	usingAbilityTo(Class<? extends T> doSomething)	A more readable way to access an actor's abilities.
Actor	usingPronoun(String pronoun)
final void	wasAbleTo(Performable... todos)	A tense-neutral synonym for addFact() for use with given() clauses
<T extends Ability> Actor	whoCan(T doSomething)	Assign an ability to an actor.
Actor	withNoPronoun()
void	wrapUp()

Methods inherited from class java.lang.Object

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

Constructor Details

Actor

public Actor(String name)

Method Details

brief

public void brief(Actor otherActor)

Add all the remembered items for the current actor to the other actor's memory

Parameters:

otherActor -

toString

public String toString()

Overrides:

toString in class Object

named

public static Actor named(String name)

Create a new actor with a given name. This actor will have no abilities initially, so you will need to assign some abilities using the whoCan() method.

describedAs

public Actor describedAs(String description)

getName

public String getName()

Specified by:

getName in interface net.serenitybdd.core.parallel.Agent

getDescription

public String getDescription()

getNameOrPronoun

public String getNameOrPronoun()

can

public <T extends Ability> Actor can(T doSomething)

whoCan

public <T extends Ability> Actor whoCan(T doSomething)

Assign an ability to an actor.

abilityTo

public <T extends Ability> T abilityTo(Class<? extends T> doSomething)

getAbilityThatExtends

public <C> C getAbilityThatExtends(Class<C> extendedClass)

Return an ability that extends the given class. Can be a Superclass or an Interface. If there are multiple candidate Abilities, the first one found will be returned.

Type Parameters:

C - the matching Ability cast to extendedClass or null if none match

Parameters:

extendedClass - the Interface class that we expect to find

getTeardowns

public List<HasTeardown> getTeardowns()

Return a list of all Abilitys which implement HasTeardown

usingAbilityTo

public <T extends Ability> T usingAbilityTo(Class<? extends T> doSomething)

A more readable way to access an actor's abilities.

entersTheScene

public final void entersTheScene()

A method used to declare that an actor is now the actor in the spotlight, without having them perform any tasks.

has

public final void has(Performable... todos)

has

public final void has(Fact... facts)

wasAbleTo

public final void wasAbleTo(Performable... todos)

A tense-neutral synonym for addFact() for use with given() clauses

attemptsTo

public final void attemptsTo(Actor.ErrorHandlingMode mode,
 Performable... tasks)

attemptsTo

public final void attemptsTo(Performable... tasks)

Specified by:

attemptsTo in interface PerformsTasks

asksFor

public <ANSWER> ANSWER asksFor(Question<ANSWER> question)

Specified by:

asksFor in interface PerformsTasks

can

public final void can(Consequence<?>... consequences)

should

public final void should(String groupStepName,
 Consequence<?>... consequences)

should

public final void should(List<Consequence<?>> consequences)

should

public final void should(Consequence<?>... consequences)

remember

public <ANSWER> void remember(String key,
 Question<ANSWER> question)

remember

public void remember(String key,
 Object value)

recall

public <T> T recall(String key)

recallAll

public Map<String,Object> recallAll()

forget

public <T> T forget(String key)

sawAsThe

public <T> T sawAsThe(String key)

gaveAsThe

public <T> T gaveAsThe(String key)

usingPronoun

public Actor usingPronoun(String pronoun)

withNoPronoun

public Actor withNoPronoun()

assignDescriptionToActor

public void assignDescriptionToActor(String description)

assignName

public void assignName(String name)

wrapUp

public void wrapUp()

getId

public String getId()

Specified by:

getId in interface net.serenitybdd.core.parallel.Agent