Package org.shakespeareframework

package org.shakespeareframework

The root package of Shakespeare contains all classes needed to implement the basic Screenplay concepts:

• Actor,
• Ability,
• Task, and
• Question.

It also contains Shakespeare's extensions to the basic Screenplay:

• Retryable, RetryableTask and RetryableQuestion, and
• Fact.

See Also:

• Manual on "Actors with Abilities"
• Manual on "Doing Tasks"
• Manual on "Checking Questions"
• Manual on "Retryables"
• Manual on "Remembering Facts"

Related Packages

Package	Description
org.shakespeareframework.reporting	The reporting package contains classes and interfaces for reporting what an Actor does: Reporter is the main interface, LoggingReporter is the interface for reporters that generate logs, Slf4jReporter is its default implementation, FileReporter can be extended to generate report files.

Class	Description
Ability	An Ability can be used by an Actor to perform a Task or answer a Question.
Actor	An Actor is the central class of the Shakespeare Framework.
Fact	A Fact to be learned and remembered by an Actor.
MissingAbilityException	A MissingAbilityException is thrown in case an Actor cannot Actor.uses(java.lang.Class<A>) a required Ability Class.
MissingFactException	A MissingFactException is thrown in case an Actor cannot Actor.remembers(java.lang.Class<F>) a required Fact Class.
Question<A>	A Question can be checked by an Actor
Retryable	Retryable is something an Actor may retry every interval until it succeeds or the timeout is reached.
RetryableQuestion<A>	A Question that will be retried until it yields an answer deemed RetryableQuestion.acceptable(A) or the timeout is reached.
RetryableTask	A Task that will be retried until it succeeds or the timeout is reached.
RetryInterruptedException	A RetryInterruptedException is thrown when an Actor get interrupted while retrying a Retryable.
Task	A Task can be done by an Actor.
TimeoutException	A TimeoutException is thrown in case an Actor does not succeed on a Retryable before its timeout is reached.