Index

A C D E F G H I L M O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

Ability - Interface in org.shakespeareframework

An Ability can be used by an Actor to perform a Task or answer a Question.

acceptable(A) - Method in interface org.shakespeareframework.RetryableQuestion

This determines if a given answer is acceptable.

Actor - Class in org.shakespeareframework

An Actor is the central class of the Shakespeare Framework.

Actor() - Constructor for class org.shakespeareframework.Actor

Picks a name from Actor.NAMES.

Actor(String) - Constructor for class org.shakespeareframework.Actor

answerAs(Actor) - Method in interface org.shakespeareframework.Question

Answer this Question as the given Actor.

C

can(Ability...) - Method in class org.shakespeareframework.Actor

checks(Question<A>) - Method in class org.shakespeareframework.Actor

checks(RetryableQuestion<A>) - Method in class org.shakespeareframework.Actor

D

DEFAULT_TIMEOUT - Static variable in interface org.shakespeareframework.Retryable

The default timeout

does(RetryableTask) - Method in class org.shakespeareframework.Actor

does(Task) - Method in class org.shakespeareframework.Actor

E

equals(Object) - Method in class org.shakespeareframework.Actor

F

Fact - Interface in org.shakespeareframework

A Fact to be learned and remembered by an Actor.

failure(Actor, Question<?>, Exception) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the unsuccessful finishing of the latest started Question due to an acknowledged exception.

failure(Actor, Question<?>, Exception) - Method in class org.shakespeareframework.reporting.Slf4jReporter

failure(Actor, Question<A>, A) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the unsuccessful finishing of the latest started RetryableQuestion due to an unacceptable answer.

failure(Actor, Question<A>, A) - Method in class org.shakespeareframework.reporting.Slf4jReporter

failure(Actor, Task, Exception) - Method in class org.shakespeareframework.reporting.Slf4jReporter

failure(Actor, Task, Exception) - Method in interface org.shakespeareframework.reporting.TaskReporter

Reports the unsuccessful finishing of the latest started Task or Question.

FAILURE - Enum constant in enum class org.shakespeareframework.reporting.FileReporter.ReportType

something was finished unsuccessfully

FileReporter - Class in org.shakespeareframework.reporting

Reporter providing a method to write report files.

FileReporter(Path) - Constructor for class org.shakespeareframework.reporting.FileReporter

FileReporter.ReportType - Enum Class in org.shakespeareframework.reporting

Possible types of reports.

G

getAcknowledgedExceptions() - Method in interface org.shakespeareframework.RetryableTask

getIgnoredExceptions() - Method in interface org.shakespeareframework.RetryableQuestion

getInterval() - Method in interface org.shakespeareframework.Retryable

getName() - Method in class org.shakespeareframework.Actor

getTimeout() - Method in interface org.shakespeareframework.Retryable

H

hashCode() - Method in class org.shakespeareframework.Actor

I

informs(Reporter...) - Method in class org.shakespeareframework.Actor

isAcknowledgedException(Exception) - Method in interface org.shakespeareframework.RetryableTask

isIgnoredException(Exception) - Method in interface org.shakespeareframework.RetryableQuestion

L

learns(Fact...) - Method in class org.shakespeareframework.Actor

LoggingReporter - Interface in org.shakespeareframework.reporting

A Reporter using a given Logger.

M

MissingAbilityException - Exception in org.shakespeareframework

A MissingAbilityException is thrown in case an Actor cannot Actor.uses(java.lang.Class<A>) a required Ability Class.

MissingAbilityException(Actor, Class<? extends Ability>) - Constructor for exception org.shakespeareframework.MissingAbilityException

MissingFactException - Exception in org.shakespeareframework

A MissingFactException is thrown in case an Actor cannot Actor.remembers(java.lang.Class<F>) a required Fact Class.

MissingFactException(Actor, Class<? extends Fact>) - Constructor for exception org.shakespeareframework.MissingFactException

O

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.

org.shakespeareframework.reporting - package 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.

P

performAs(Actor) - Method in interface org.shakespeareframework.Task

Perform this Task as the given Actor.

Q

Question<A> - Interface in org.shakespeareframework

A Question can be checked by an Actor

QuestionReporter - Interface in org.shakespeareframework.reporting

A QuestionReporter to be informed by Actors about their actions.

R

remembers(Class<F>) - Method in class org.shakespeareframework.Actor

Reporter - Interface in org.shakespeareframework.reporting

A Reporter to be informed by Actors about their actions.

retry(Actor, RetryableQuestion<?>, Exception) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the retry of the latest started RetryableQuestion due to an ignored exception.

retry(Actor, RetryableQuestion<?>, Exception) - Method in class org.shakespeareframework.reporting.Slf4jReporter

retry(Actor, RetryableQuestion<A>, A) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the retry of the latest started RetryableQuestion due to an unacceptable answer.

retry(Actor, RetryableQuestion<A>, A) - Method in class org.shakespeareframework.reporting.Slf4jReporter

retry(Actor, RetryableTask, Exception) - Method in class org.shakespeareframework.reporting.Slf4jReporter

retry(Actor, RetryableTask, Exception) - Method in interface org.shakespeareframework.reporting.TaskReporter

Reports the retry of the latest started RetryableTask.

RETRY - Enum constant in enum class org.shakespeareframework.reporting.FileReporter.ReportType

something was retried

Retryable - Interface in org.shakespeareframework

Retryable is something an Actor may retry every interval until it succeeds or the timeout is reached.

RetryableQuestion<A> - Interface in org.shakespeareframework

A Question that will be retried until it yields an answer deemed RetryableQuestion.acceptable(A) or the timeout is reached.

RetryableTask - Interface in org.shakespeareframework

A Task that will be retried until it succeeds or the timeout is reached.

RetryInterruptedException - Exception in org.shakespeareframework

A RetryInterruptedException is thrown when an Actor get interrupted while retrying a Retryable.

RetryInterruptedException(Actor, Retryable, InterruptedException) - Constructor for exception org.shakespeareframework.RetryInterruptedException

S

Slf4jReporter - Class in org.shakespeareframework.reporting

LoggingReporter that logs to SLF4J.

Slf4jReporter() - Constructor for class org.shakespeareframework.reporting.Slf4jReporter

start(Actor, Question<?>) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the start of checking the given Question.

start(Actor, Question<?>) - Method in class org.shakespeareframework.reporting.Slf4jReporter

start(Actor, Task) - Method in class org.shakespeareframework.reporting.Slf4jReporter

start(Actor, Task) - Method in interface org.shakespeareframework.reporting.TaskReporter

Reports the start of doing the given Task.

START - Enum constant in enum class org.shakespeareframework.reporting.FileReporter.ReportType

something was started

success(Actor, Question<A>, A) - Method in interface org.shakespeareframework.reporting.QuestionReporter

Reports the successful finishing of the lastest started Question.

success(Actor, Question<A>, A) - Method in class org.shakespeareframework.reporting.Slf4jReporter

success(Actor, Task) - Method in class org.shakespeareframework.reporting.Slf4jReporter

success(Actor, Task) - Method in interface org.shakespeareframework.reporting.TaskReporter

Reports the successful finishing of the latest started Task.

SUCCESS - Enum constant in enum class org.shakespeareframework.reporting.FileReporter.ReportType

something was finished successfully

T

Task - Interface in org.shakespeareframework

A Task can be done by an Actor.

TaskReporter - Interface in org.shakespeareframework.reporting

A TaskReporter to be informed by Actors about their actions.

TimeoutException - Exception in org.shakespeareframework

A TimeoutException is thrown in case an Actor does not succeed on a Retryable before its timeout is reached.

TimeoutException(Actor, Retryable, Throwable) - Constructor for exception org.shakespeareframework.TimeoutException

toString() - Method in class org.shakespeareframework.Actor

toString() - Method in enum class org.shakespeareframework.reporting.FileReporter.ReportType

U

uses(Class<A>) - Method in class org.shakespeareframework.Actor

V

valueOf(String) - Static method in enum class org.shakespeareframework.reporting.FileReporter.ReportType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.shakespeareframework.reporting.FileReporter.ReportType

Returns an array containing the constants of this enum class, in the order they are declared.

W

writeReport(Actor, FileReporter.ReportType, Object, String, byte[]) - Method in class org.shakespeareframework.reporting.FileReporter

Writes the given content to a new file in the FileReporter.reportsPath.

WriteReportFileException - Exception in org.shakespeareframework.reporting

A WriteReportFileException is thrown when the FileReporter fails create a report file.

WriteReportFileException(String, IOException) - Constructor for exception org.shakespeareframework.reporting.WriteReportFileException

A C D E F G H I L M O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form