diff --git a/docs/latest b/docs/latest index d30f2f6b..1d69c172 120000 --- a/docs/latest +++ b/docs/latest @@ -1 +1 @@ -./v0.8 \ No newline at end of file +./v0.8.1 \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/allclasses-index.html b/docs/v0.8.1/javadoc/core/allclasses-index.html new file mode 100644 index 00000000..f0a699c9 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/allclasses-index.html @@ -0,0 +1,158 @@ + + + + +All Classes and Interfaces (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+ +
+
An Ability can be used by an Actor to perform a Task or answer a Question.
+
+ +
+
An Actor is the central class of the Shakespeare Framework.
+
+ +
+
A Fact to be learned and remembered by an + Actor.
+
+ +
+
Reporter providing a method to write report files.
+
+ +
+
Possible types of reports.
+
+ +
+
A Reporter using a given Logger.
+
+ +
+
A MissingAbilityException is thrown in case an Actor cannot Actor.uses(java.lang.Class<A>) a + required Ability Class.
+
+ +
+
A MissingFactException is thrown in case an Actor cannot Actor.remembers(java.lang.Class<F>) + a required Fact Class.
+
+ +
+
A Question can be checked by an Actor
+
+ +
+
A QuestionReporter to be informed by Actors about their + actions.
+
+ +
+
A Reporter to be informed by Actors about their actions.
+
+ +
+
Retryable is something an Actor may retry every interval + until it succeeds or the timeout is reached.
+
+ +
+
A Question that will be retried until it yields an answer deemed RetryableQuestion.acceptable(A) or + the timeout is reached.
+
+ +
+
A Task that will be retried until it succeeds or the timeout is reached.
+
+ +
+
A RetryInterruptedException is thrown when an Actor get interrupted while + retrying a Retryable.
+
+ +
+
LoggingReporter that logs to SLF4J.
+
+ +
+
A Task can be done by an Actor.
+
+ +
+
A TaskReporter to be informed by Actors about their + actions.
+
+ +
+
A TimeoutException is thrown in case an Actor does not succeed on a Retryable before its timeout is reached.
+
+ +
+
A WriteReportFileException is thrown when the FileReporter fails create a report + file.
+
+
+
+
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/allpackages-index.html b/docs/v0.8.1/javadoc/core/allpackages-index.html new file mode 100644 index 00000000..46319d54 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/allpackages-index.html @@ -0,0 +1,84 @@ + + + + +All Packages (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
Package Summary
+
+
Package
+
Description
+ +
+
The root package of Shakespeare contains all classes needed to implement the basic Screenplay + concepts: + + + Actor, + Ability, + Task, and + Question.
+
+ +
+
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.
+
+
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/element-list b/docs/v0.8.1/javadoc/core/element-list new file mode 100644 index 00000000..aef3afd0 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/element-list @@ -0,0 +1,2 @@ +org.shakespeareframework +org.shakespeareframework.reporting diff --git a/docs/v0.8.1/javadoc/core/help-doc.html b/docs/v0.8.1/javadoc/core/help-doc.html new file mode 100644 index 00000000..43319fee --- /dev/null +++ b/docs/v0.8.1/javadoc/core/help-doc.html @@ -0,0 +1,180 @@ + + + + +API Help (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
+
+
+

Kinds of Pages

+The following sections describe the different kinds of pages in this collection. +
+

Overview

+

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+
+
+

Package

+

Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

+
    +
  • Interfaces
  • +
  • Classes
  • +
  • Enum Classes
  • +
  • Exceptions
  • +
  • Errors
  • +
  • Annotation Interfaces
  • +
+
+
+

Class or Interface

+

Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

+
    +
  • Class Inheritance Diagram
  • +
  • Direct Subclasses
  • +
  • All Known Subinterfaces
  • +
  • All Known Implementing Classes
  • +
  • Class or Interface Declaration
  • +
  • Class or Interface Description
  • +
+
+
    +
  • Nested Class Summary
  • +
  • Enum Constant Summary
  • +
  • Field Summary
  • +
  • Property Summary
  • +
  • Constructor Summary
  • +
  • Method Summary
  • +
  • Required Element Summary
  • +
  • Optional Element Summary
  • +
+
+
    +
  • Enum Constant Details
  • +
  • Field Details
  • +
  • Property Details
  • +
  • Constructor Details
  • +
  • Method Details
  • +
  • Element Details
  • +
+

Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

+

The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

+
+
+

Other Files

+

Packages and modules may contain pages with additional information related to the declarations nearby.

+
+
+

Tree (Class Hierarchy)

+

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

+
    +
  • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
  • +
  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
  • +
+
+
+

Serialized Form

+

Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

+
+
+

All Packages

+

The All Packages page contains an alphabetic index of all packages contained in the documentation.

+
+
+

All Classes and Interfaces

+

The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/index-all.html b/docs/v0.8.1/javadoc/core/index-all.html new file mode 100644 index 00000000..1108cd8b --- /dev/null +++ b/docs/v0.8.1/javadoc/core/index-all.html @@ -0,0 +1,394 @@ + + + + +Index (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

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
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/index.html b/docs/v0.8.1/javadoc/core/index.html new file mode 100644 index 00000000..c1bf4143 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/index.html @@ -0,0 +1,86 @@ + + + + +Overview (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

core 0.8.1 API

+
+
+
Packages
+
+
Package
+
Description
+ +
+
The root package of Shakespeare contains all classes needed to implement the basic Screenplay + concepts: + + + Actor, + Ability, + Task, and + Question.
+
+ +
+
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.
+
+
+
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/jquery-ui.overrides.css b/docs/v0.8.1/javadoc/core/jquery-ui.overrides.css new file mode 100644 index 00000000..facf852c --- /dev/null +++ b/docs/v0.8.1/javadoc/core/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/docs/v0.8.1/javadoc/core/legal/ADDITIONAL_LICENSE_INFO b/docs/v0.8.1/javadoc/core/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 00000000..ff700cd0 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/v0.8.1/javadoc/core/legal/ASSEMBLY_EXCEPTION b/docs/v0.8.1/javadoc/core/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 00000000..065b8d90 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/v0.8.1/javadoc/core/legal/LICENSE b/docs/v0.8.1/javadoc/core/legal/LICENSE new file mode 100644 index 00000000..8b400c7a --- /dev/null +++ b/docs/v0.8.1/javadoc/core/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/v0.8.1/javadoc/core/legal/jquery.md b/docs/v0.8.1/javadoc/core/legal/jquery.md new file mode 100644 index 00000000..d468b318 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/docs/v0.8.1/javadoc/core/legal/jqueryUI.md b/docs/v0.8.1/javadoc/core/legal/jqueryUI.md new file mode 100644 index 00000000..8bda9d7a --- /dev/null +++ b/docs/v0.8.1/javadoc/core/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/v0.8.1/javadoc/core/member-search-index.js b/docs/v0.8.1/javadoc/core/member-search-index.js new file mode 100644 index 00000000..a856029a --- /dev/null +++ b/docs/v0.8.1/javadoc/core/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.shakespeareframework","c":"RetryableQuestion","l":"acceptable(A)"},{"p":"org.shakespeareframework","c":"Actor","l":"Actor()","u":"%3Cinit%3E()"},{"p":"org.shakespeareframework","c":"Actor","l":"Actor(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.shakespeareframework","c":"Question","l":"answerAs(Actor)","u":"answerAs(org.shakespeareframework.Actor)"},{"p":"org.shakespeareframework","c":"Actor","l":"can(Ability...)","u":"can(org.shakespeareframework.Ability...)"},{"p":"org.shakespeareframework","c":"Actor","l":"checks(Question)","u":"checks(org.shakespeareframework.Question)"},{"p":"org.shakespeareframework","c":"Actor","l":"checks(RetryableQuestion)","u":"checks(org.shakespeareframework.RetryableQuestion)"},{"p":"org.shakespeareframework","c":"Retryable","l":"DEFAULT_TIMEOUT"},{"p":"org.shakespeareframework","c":"Actor","l":"does(RetryableTask)","u":"does(org.shakespeareframework.RetryableTask)"},{"p":"org.shakespeareframework","c":"Actor","l":"does(Task)","u":"does(org.shakespeareframework.Task)"},{"p":"org.shakespeareframework","c":"Actor","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"FAILURE"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"failure(Actor, Question, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"failure(Actor, Question, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"failure(Actor, Question, A)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"failure(Actor, Question, A)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"failure(Actor, Task, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Task,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"TaskReporter","l":"failure(Actor, Task, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Task,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter","l":"FileReporter(Path)","u":"%3Cinit%3E(java.nio.file.Path)"},{"p":"org.shakespeareframework","c":"RetryableTask","l":"getAcknowledgedExceptions()"},{"p":"org.shakespeareframework","c":"RetryableQuestion","l":"getIgnoredExceptions()"},{"p":"org.shakespeareframework","c":"Retryable","l":"getInterval()"},{"p":"org.shakespeareframework","c":"Actor","l":"getName()"},{"p":"org.shakespeareframework","c":"Retryable","l":"getTimeout()"},{"p":"org.shakespeareframework","c":"Actor","l":"hashCode()"},{"p":"org.shakespeareframework","c":"Actor","l":"informs(Reporter...)","u":"informs(org.shakespeareframework.reporting.Reporter...)"},{"p":"org.shakespeareframework","c":"RetryableTask","l":"isAcknowledgedException(Exception)","u":"isAcknowledgedException(java.lang.Exception)"},{"p":"org.shakespeareframework","c":"RetryableQuestion","l":"isIgnoredException(Exception)","u":"isIgnoredException(java.lang.Exception)"},{"p":"org.shakespeareframework","c":"Actor","l":"learns(Fact...)","u":"learns(org.shakespeareframework.Fact...)"},{"p":"org.shakespeareframework","c":"MissingAbilityException","l":"MissingAbilityException(Actor, Class)","u":"%3Cinit%3E(org.shakespeareframework.Actor,java.lang.Class)"},{"p":"org.shakespeareframework","c":"MissingFactException","l":"MissingFactException(Actor, Class)","u":"%3Cinit%3E(org.shakespeareframework.Actor,java.lang.Class)"},{"p":"org.shakespeareframework","c":"Task","l":"performAs(Actor)","u":"performAs(org.shakespeareframework.Actor)"},{"p":"org.shakespeareframework","c":"Actor","l":"remembers(Class)","u":"remembers(java.lang.Class)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"RETRY"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"retry(Actor, RetryableQuestion, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"retry(Actor, RetryableQuestion, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"retry(Actor, RetryableQuestion, A)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"retry(Actor, RetryableQuestion, A)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"retry(Actor, RetryableTask, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableTask,java.lang.Exception)"},{"p":"org.shakespeareframework.reporting","c":"TaskReporter","l":"retry(Actor, RetryableTask, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableTask,java.lang.Exception)"},{"p":"org.shakespeareframework","c":"RetryInterruptedException","l":"RetryInterruptedException(Actor, Retryable, InterruptedException)","u":"%3Cinit%3E(org.shakespeareframework.Actor,org.shakespeareframework.Retryable,java.lang.InterruptedException)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"Slf4jReporter()","u":"%3Cinit%3E()"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"START"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"start(Actor, Question)","u":"start(org.shakespeareframework.Actor,org.shakespeareframework.Question)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"start(Actor, Question)","u":"start(org.shakespeareframework.Actor,org.shakespeareframework.Question)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"start(Actor, Task)","u":"start(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework.reporting","c":"TaskReporter","l":"start(Actor, Task)","u":"start(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"SUCCESS"},{"p":"org.shakespeareframework.reporting","c":"QuestionReporter","l":"success(Actor, Question, A)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"success(Actor, Question, A)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.reporting","c":"Slf4jReporter","l":"success(Actor, Task)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework.reporting","c":"TaskReporter","l":"success(Actor, Task)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework","c":"TimeoutException","l":"TimeoutException(Actor, Retryable, Throwable)","u":"%3Cinit%3E(org.shakespeareframework.Actor,org.shakespeareframework.Retryable,java.lang.Throwable)"},{"p":"org.shakespeareframework","c":"Actor","l":"toString()"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"toString()"},{"p":"org.shakespeareframework","c":"Actor","l":"uses(Class)","u":"uses(java.lang.Class)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.shakespeareframework.reporting","c":"FileReporter.ReportType","l":"values()"},{"p":"org.shakespeareframework.reporting","c":"FileReporter","l":"writeReport(Actor, FileReporter.ReportType, Object, String, byte[])","u":"writeReport(org.shakespeareframework.Actor,org.shakespeareframework.reporting.FileReporter.ReportType,java.lang.Object,java.lang.String,byte[])"},{"p":"org.shakespeareframework.reporting","c":"WriteReportFileException","l":"WriteReportFileException(String, IOException)","u":"%3Cinit%3E(java.lang.String,java.io.IOException)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/module-search-index.js b/docs/v0.8.1/javadoc/core/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/docs/v0.8.1/javadoc/core/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Ability.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Ability.html new file mode 100644 index 00000000..dcfc6bb9 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Ability.html @@ -0,0 +1,79 @@ + + + + +Ability (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Ability

+
+
+
+
public interface Ability
+
An Ability can be used by an Actor to perform a Task or answer a Question.
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Actor.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Actor.html new file mode 100644 index 00000000..cf6f0819 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Actor.html @@ -0,0 +1,372 @@ + + + + +Actor (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

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 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

    + +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Fact.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Fact.html new file mode 100644 index 00000000..adf4bc05 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Fact.html @@ -0,0 +1,80 @@ + + + + +Fact (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Fact

+
+
+
+
public interface Fact
+
A Fact to be learned and remembered by an + Actor.
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingAbilityException.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingAbilityException.html new file mode 100644 index 00000000..d4433b74 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingAbilityException.html @@ -0,0 +1,157 @@ + + + + +MissingAbilityException (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class MissingAbilityException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
org.shakespeareframework.MissingAbilityException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
@NullMarked +public class MissingAbilityException +extends RuntimeException
+
A MissingAbilityException is thrown in case an Actor cannot Actor.uses(java.lang.Class<A>) a + required Ability Class.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MissingAbilityException

      +
      public MissingAbilityException(Actor actor, + Class<? extends Ability> abilityClass)
      +
      +
      Parameters:
      +
      actor - the Actor missing the abilityClass
      +
      abilityClass - the class of the missing Ability
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingFactException.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingFactException.html new file mode 100644 index 00000000..0bd8c1a5 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/MissingFactException.html @@ -0,0 +1,157 @@ + + + + +MissingFactException (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class MissingFactException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
org.shakespeareframework.MissingFactException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
@NullMarked +public class MissingFactException +extends RuntimeException
+
A MissingFactException is thrown in case an Actor cannot Actor.remembers(java.lang.Class<F>) + a required Fact Class.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MissingFactException

      +
      public MissingFactException(Actor actor, + Class<? extends Fact> factClass)
      +
      +
      Parameters:
      +
      actor - the Actor missing the factClass
      +
      factClass - the class of the missing Fact
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Question.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Question.html new file mode 100644 index 00000000..2ddaa15d --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Question.html @@ -0,0 +1,146 @@ + + + + +Question (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Question<A>

+
+
+
+
Type Parameters:
+
A - the Class of the Question's answer
+
+
+
All Known Subinterfaces:
+
RetryableQuestion<A>
+
+
+
Functional Interface:
+
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
+
+
+
@FunctionalInterface +public interface Question<A>
+
A Question can be checked by an Actor
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + +
    answerAs(Actor actor)
    +
    +
    Answer this Question as the given Actor.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryInterruptedException.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryInterruptedException.html new file mode 100644 index 00000000..e15a7c5e --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryInterruptedException.html @@ -0,0 +1,162 @@ + + + + +RetryInterruptedException (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class RetryInterruptedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
org.shakespeareframework.RetryInterruptedException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
@NullMarked +public class RetryInterruptedException +extends RuntimeException
+
A RetryInterruptedException is thrown when an Actor get interrupted while + retrying a Retryable.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Retryable.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Retryable.html new file mode 100644 index 00000000..99906e56 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Retryable.html @@ -0,0 +1,178 @@ + + + + +Retryable (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Retryable

+
+
+
+
All Known Subinterfaces:
+
RetryableQuestion<A>, RetryableTask
+
+
+
public interface Retryable
+
Retryable is something an Actor may retry every interval + until it succeeds or the timeout is reached.
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final Duration
    + +
    +
    The default timeout
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    default Duration
    + +
     
    +
    default Duration
    + +
     
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      DEFAULT_TIMEOUT

      +
      static final Duration DEFAULT_TIMEOUT
      +
      The default timeout
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getTimeout

      +
      default Duration getTimeout()
      +
      +
      Returns:
      +
      the timeout for this (default: DEFAULT_TIMEOUT)
      +
      +
      +
    • +
    • +
      +

      getInterval

      +
      default Duration getInterval()
      +
      +
      Returns:
      +
      the interval to retry this (default getTimeout() / 10)
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableQuestion.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableQuestion.html new file mode 100644 index 00000000..987072ef --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableQuestion.html @@ -0,0 +1,195 @@ + + + + +RetryableQuestion (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface RetryableQuestion<A>

+
+
+
+
All Superinterfaces:
+
Question<A>, Retryable
+
+
+
public interface RetryableQuestion<A> +extends Question<A>, Retryable
+
A Question that will be retried until it yields an answer deemed acceptable(A) or + the timeout is reached. Exceptions thrown will be ignored + if they match the isIgnoredException predicate.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getIgnoredExceptions

      +
      default Set<Class<? extends Exception>> getIgnoredExceptions()
      +
      +
      Returns:
      +
      the Set of Exception classes that will be ignored when thrown in a + retry
      +
      +
      +
    • +
    • +
      +

      isIgnoredException

      +
      default boolean isIgnoredException(Exception exception)
      +
      +
      Parameters:
      +
      exception - the Exception that made the retry necessary
      +
      Returns:
      +
      the predicate that decides weather the exception will be ignored when thrown in a retry
      +
      +
      +
    • +
    • +
      +

      acceptable

      +
      default boolean acceptable(A answer)
      +
      This determines if a given answer is acceptable. In that case the retrying will be stopped and + the answer is returned. + +

      By default this will accept + +

      +
      +
      Parameters:
      +
      answer - an answer
      +
      Returns:
      +
      true if the given answer is acceptable
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableTask.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableTask.html new file mode 100644 index 00000000..8b31869f --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/RetryableTask.html @@ -0,0 +1,166 @@ + + + + +RetryableTask (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface RetryableTask

+
+
+
+
All Superinterfaces:
+
Retryable, Task
+
+
+
public interface RetryableTask +extends Task, Retryable
+
A Task that will be retried until it succeeds or the timeout is reached. Exceptions thrown will be ignored by default unless they match + the acknowledged exception predicate.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAcknowledgedExceptions

      +
      default Set<Class<? extends Exception>> getAcknowledgedExceptions()
      +
      +
      Returns:
      +
      the Set of Exception classes that won't be ignored when thrown in a + retry
      +
      +
      +
    • +
    • +
      +

      isAcknowledgedException

      +
      default boolean isAcknowledgedException(Exception exception)
      +
      +
      Parameters:
      +
      exception - the Exception that made the retry necessary
      +
      Returns:
      +
      the predicate that decides weather the exception won't be ignored when thrown in a + retry
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/Task.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Task.html new file mode 100644 index 00000000..205cfe88 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/Task.html @@ -0,0 +1,140 @@ + + + + +Task (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Task

+
+
+
+
All Known Subinterfaces:
+
RetryableTask
+
+
+
Functional Interface:
+
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
+
+
+
@FunctionalInterface +public interface Task
+
A Task can be done by an Actor.
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Perform this Task as the given Actor.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      performAs

      +
      void performAs(Actor actor)
      +
      Perform this Task as the given Actor.
      +
      +
      Parameters:
      +
      actor - the Actor to perform this.
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/TimeoutException.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/TimeoutException.html new file mode 100644 index 00000000..8215bbf3 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/TimeoutException.html @@ -0,0 +1,159 @@ + + + + +TimeoutException (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class TimeoutException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
org.shakespeareframework.TimeoutException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
@NullMarked +public class TimeoutException +extends RuntimeException
+
A TimeoutException is thrown in case an Actor does not succeed on a Retryable before its timeout is reached.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TimeoutException

      +
      public TimeoutException(Actor actor, + Retryable retryable, + Throwable lastException)
      +
      +
      Parameters:
      +
      actor - the Actor ran into the timeout
      +
      retryable - the Retryable which was not successful before its timeout
      +
      lastException - the exception that was thrown in the last retry
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-summary.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-summary.html new file mode 100644 index 00000000..408c9248 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-summary.html @@ -0,0 +1,196 @@ + + + + +org.shakespeareframework (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package org.shakespeareframework

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

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

+
+
See Also:
+
+ +
+
+
+
+ +
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-tree.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-tree.html new file mode 100644 index 00000000..517ba3d3 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/package-tree.html @@ -0,0 +1,109 @@ + + + + +org.shakespeareframework Class Hierarchy (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.shakespeareframework

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.ReportType.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.ReportType.html new file mode 100644 index 00000000..51647fd2 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.ReportType.html @@ -0,0 +1,262 @@ + + + + +FileReporter.ReportType (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class FileReporter.ReportType

+
+
java.lang.Object +
java.lang.Enum<FileReporter.ReportType> +
org.shakespeareframework.reporting.FileReporter.ReportType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<FileReporter.ReportType>, Constable
+
+
+
Enclosing class:
+
FileReporter
+
+
+
public static enum FileReporter.ReportType +extends Enum<FileReporter.ReportType>
+
Possible types of reports.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static FileReporter.ReportType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static FileReporter.ReportType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Enum<FileReporter.ReportType>
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.html new file mode 100644 index 00000000..aeb3e2ea --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/FileReporter.html @@ -0,0 +1,225 @@ + + + + +FileReporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class FileReporter

+
+
java.lang.Object +
org.shakespeareframework.reporting.FileReporter
+
+
+
+
All Implemented Interfaces:
+
QuestionReporter, Reporter, TaskReporter
+
+
+
@NullMarked +public abstract class FileReporter +extends Object +implements Reporter
+
Reporter providing a method to write report files. Files will be placed under the reportsPath and named counter-actor-reportType- + task|question.fileNameExtension. E.g.: 003-regina-retry-is_logged_in.png.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FileReporter

      +
      protected FileReporter(Path reportsPath)
      +
      +
      Parameters:
      +
      reportsPath - path to the reports directory
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      writeReport

      +
      protected void writeReport(Actor actor, + FileReporter.ReportType reportType, + Object activity, + String fileNameExtension, + byte[] content)
      +
      Writes the given content to a new file in the reportsPath. The reportsPath is + automatically created if necessary. + +

      The filename will be structured as follows: + +

      + [increased counter with leading zeros]-[actor.name]- + [reportType]-[activity].[fileNameExtension] + + +

      E.g. 001-fiona-start-some_question.txt

      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      reportType - the FileReporter.ReportType
      +
      activity - the Task or Question this report is about.
      +
      fileNameExtension - The file name extension for the report file
      +
      content - the content to write
      +
      Throws:
      +
      RuntimeException - if creating the reportsPath or writing the file fails
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/LoggingReporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/LoggingReporter.html new file mode 100644 index 00000000..d2800a14 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/LoggingReporter.html @@ -0,0 +1,104 @@ + + + + +LoggingReporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface LoggingReporter

+
+
+
+
All Superinterfaces:
+
QuestionReporter, Reporter, TaskReporter
+
+
+
All Known Implementing Classes:
+
Slf4jReporter
+
+
+
public interface LoggingReporter +extends Reporter
+
A Reporter using a given Logger.
+
+
+ +
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/QuestionReporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/QuestionReporter.html new file mode 100644 index 00000000..1d548993 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/QuestionReporter.html @@ -0,0 +1,265 @@ + + + + +QuestionReporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface QuestionReporter

+
+
+
+
All Known Subinterfaces:
+
LoggingReporter, Reporter
+
+
+
All Known Implementing Classes:
+
FileReporter, Slf4jReporter
+
+
+
public interface QuestionReporter
+
A QuestionReporter to be informed by Actors about their + actions.
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    default void
    +
    failure(Actor actor, + Question<?> question, + Exception cause)
    +
    +
    Reports the unsuccessful finishing of the latest started Question due to an + acknowledged exception.
    +
    +
    default <A> void
    +
    failure(Actor actor, + Question<A> question, + A answer)
    +
    +
    Reports the unsuccessful finishing of the latest started RetryableQuestion due to an + unacceptable answer.
    +
    +
    default void
    +
    retry(Actor actor, + RetryableQuestion<?> question, + Exception cause)
    +
    +
    Reports the retry of the latest started RetryableQuestion due to an ignored exception.
    +
    +
    default <A> void
    +
    retry(Actor actor, + RetryableQuestion<A> question, + A answer)
    +
    +
    Reports the retry of the latest started RetryableQuestion due to an unacceptable + answer.
    +
    +
    default void
    +
    start(Actor actor, + Question<?> question)
    +
    +
    Reports the start of checking the given Question.
    +
    +
    default <A> void
    +
    success(Actor actor, + Question<A> question, + A answer)
    +
    +
    Reports the successful finishing of the lastest started Question.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      default void start(Actor actor, + Question<?> question)
      +
      Reports the start of checking the given Question.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the started Question
      +
      +
      +
    • +
    • +
      +

      retry

      +
      default void retry(Actor actor, + RetryableQuestion<?> question, + Exception cause)
      +
      Reports the retry of the latest started RetryableQuestion due to an ignored exception.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the retried question
      +
      cause - the cause for the retry
      +
      +
      +
    • +
    • +
      +

      retry

      +
      default <A> void retry(Actor actor, + RetryableQuestion<A> question, + A answer)
      +
      Reports the retry of the latest started RetryableQuestion due to an unacceptable + answer.
      +
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the retried question
      +
      answer - the current unacceptable answer
      +
      +
      +
    • +
    • +
      +

      success

      +
      default <A> void success(Actor actor, + Question<A> question, + A answer)
      +
      Reports the successful finishing of the lastest started Question.
      +
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the successfully finished Question
      +
      answer - the found answer
      +
      +
      +
    • +
    • +
      +

      failure

      +
      default void failure(Actor actor, + Question<?> question, + Exception cause)
      +
      Reports the unsuccessful finishing of the latest started Question due to an + acknowledged exception.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the unsuccessfully finished Question
      +
      cause - the cause of the failure
      +
      +
      +
    • +
    • +
      +

      failure

      +
      default <A> void failure(Actor actor, + Question<A> question, + A answer)
      +
      Reports the unsuccessful finishing of the latest started RetryableQuestion due to an + unacceptable answer.
      +
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the unsuccessfully finished Question
      +
      answer - the found answer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Reporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Reporter.html new file mode 100644 index 00000000..20ee7f99 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Reporter.html @@ -0,0 +1,108 @@ + + + + +Reporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Reporter

+
+
+
+
All Superinterfaces:
+
QuestionReporter, TaskReporter
+
+
+
All Known Subinterfaces:
+
LoggingReporter
+
+
+
All Known Implementing Classes:
+
FileReporter, Slf4jReporter
+
+
+
public interface Reporter +extends TaskReporter, QuestionReporter
+
A Reporter to be informed by Actors about their actions.
+
+
+ +
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Slf4jReporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Slf4jReporter.html new file mode 100644 index 00000000..e8c66d0f --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/Slf4jReporter.html @@ -0,0 +1,408 @@ + + + + +Slf4jReporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Slf4jReporter

+
+
java.lang.Object +
org.shakespeareframework.reporting.Slf4jReporter
+
+
+
+
All Implemented Interfaces:
+
LoggingReporter, QuestionReporter, Reporter, TaskReporter
+
+
+
@NullMarked +public class Slf4jReporter +extends Object +implements LoggingReporter
+
LoggingReporter that logs to SLF4J.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Slf4jReporter

      +
      public Slf4jReporter()
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      public void start(Actor actor, + Task task)
      +
      Description copied from interface: TaskReporter
      +
      Reports the start of doing the given Task.
      +
      +
      Specified by:
      +
      start in interface TaskReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the started Task
      +
      +
      +
    • +
    • +
      +

      start

      +
      public void start(Actor actor, + Question<?> question)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the start of checking the given Question.
      +
      +
      Specified by:
      +
      start in interface QuestionReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the started Question
      +
      +
      +
    • +
    • +
      +

      retry

      +
      public void retry(Actor actor, + RetryableTask task, + Exception cause)
      +
      Description copied from interface: TaskReporter
      +
      Reports the retry of the latest started RetryableTask.
      +
      +
      Specified by:
      +
      retry in interface TaskReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the retried Task
      +
      cause - the cause for the retry
      +
      +
      +
    • +
    • +
      +

      retry

      +
      public <A> void retry(Actor actor, + RetryableQuestion<A> question, + A answer)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the retry of the latest started RetryableQuestion due to an unacceptable + answer.
      +
      +
      Specified by:
      +
      retry in interface QuestionReporter
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the retried question
      +
      answer - the current unacceptable answer
      +
      +
      +
    • +
    • +
      +

      retry

      +
      public void retry(Actor actor, + RetryableQuestion<?> question, + Exception cause)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the retry of the latest started RetryableQuestion due to an ignored exception.
      +
      +
      Specified by:
      +
      retry in interface QuestionReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the retried question
      +
      cause - the cause for the retry
      +
      +
      +
    • +
    • +
      +

      success

      +
      public void success(Actor actor, + Task task)
      +
      Description copied from interface: TaskReporter
      +
      Reports the successful finishing of the latest started Task.
      +
      +
      Specified by:
      +
      success in interface TaskReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the successfully finished Task
      +
      +
      +
    • +
    • +
      +

      success

      +
      public <A> void success(Actor actor, + Question<A> question, + A answer)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the successful finishing of the lastest started Question.
      +
      +
      Specified by:
      +
      success in interface QuestionReporter
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the successfully finished Question
      +
      answer - the found answer
      +
      +
      +
    • +
    • +
      +

      failure

      +
      public void failure(Actor actor, + Task task, + Exception cause)
      +
      Description copied from interface: TaskReporter
      +
      Reports the unsuccessful finishing of the latest started Task or Question.
      +
      +
      Specified by:
      +
      failure in interface TaskReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the unsuccessfully finished Task
      +
      cause - the cause of the failure
      +
      +
      +
    • +
    • +
      +

      failure

      +
      public void failure(Actor actor, + Question<?> question, + Exception cause)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the unsuccessful finishing of the latest started Question due to an + acknowledged exception.
      +
      +
      Specified by:
      +
      failure in interface QuestionReporter
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the unsuccessfully finished Question
      +
      cause - the cause of the failure
      +
      +
      +
    • +
    • +
      +

      failure

      +
      public <A> void failure(Actor actor, + Question<A> question, + A answer)
      +
      Description copied from interface: QuestionReporter
      +
      Reports the unsuccessful finishing of the latest started RetryableQuestion due to an + unacceptable answer.
      +
      +
      Specified by:
      +
      failure in interface QuestionReporter
      +
      Type Parameters:
      +
      A - the type of the given answer
      +
      Parameters:
      +
      actor - the acting Actor
      +
      question - the unsuccessfully finished Question
      +
      answer - the found answer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/TaskReporter.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/TaskReporter.html new file mode 100644 index 00000000..a38a3c82 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/TaskReporter.html @@ -0,0 +1,206 @@ + + + + +TaskReporter (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface TaskReporter

+
+
+
+
All Known Subinterfaces:
+
LoggingReporter, Reporter
+
+
+
All Known Implementing Classes:
+
FileReporter, Slf4jReporter
+
+
+
public interface TaskReporter
+
A TaskReporter to be informed by Actors about their + actions.
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    default void
    +
    failure(Actor actor, + Task task, + Exception cause)
    +
    +
    Reports the unsuccessful finishing of the latest started Task or Question.
    +
    +
    default void
    +
    retry(Actor actor, + RetryableTask task, + Exception cause)
    +
    +
    Reports the retry of the latest started RetryableTask.
    +
    +
    default void
    +
    start(Actor actor, + Task task)
    +
    +
    Reports the start of doing the given Task.
    +
    +
    default void
    +
    success(Actor actor, + Task task)
    +
    +
    Reports the successful finishing of the latest started Task.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      default void start(Actor actor, + Task task)
      +
      Reports the start of doing the given Task.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the started Task
      +
      +
      +
    • +
    • +
      +

      retry

      +
      default void retry(Actor actor, + RetryableTask task, + Exception cause)
      +
      Reports the retry of the latest started RetryableTask.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the retried Task
      +
      cause - the cause for the retry
      +
      +
      +
    • +
    • +
      +

      success

      +
      default void success(Actor actor, + Task task)
      +
      Reports the successful finishing of the latest started Task.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the successfully finished Task
      +
      +
      +
    • +
    • +
      +

      failure

      +
      default void failure(Actor actor, + Task task, + Exception cause)
      +
      Reports the unsuccessful finishing of the latest started Task or Question.
      +
      +
      Parameters:
      +
      actor - the acting Actor
      +
      task - the unsuccessfully finished Task
      +
      cause - the cause of the failure
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/WriteReportFileException.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/WriteReportFileException.html new file mode 100644 index 00000000..98995e27 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/WriteReportFileException.html @@ -0,0 +1,157 @@ + + + + +WriteReportFileException (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class WriteReportFileException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
org.shakespeareframework.reporting.WriteReportFileException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
@NullMarked +public class WriteReportFileException +extends RuntimeException
+
A WriteReportFileException is thrown when the FileReporter fails create a report + file.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      WriteReportFileException

      +
      public WriteReportFileException(String message, + IOException cause)
      +
      +
      Parameters:
      +
      message - the message
      +
      cause - the causing IOException
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-summary.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-summary.html new file mode 100644 index 00000000..23c2a152 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-summary.html @@ -0,0 +1,161 @@ + + + + +org.shakespeareframework.reporting (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package org.shakespeareframework.reporting

+
+
+
package org.shakespeareframework.reporting
+
+
The reporting package contains classes and interfaces for reporting what an Actor does: + +
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-tree.html b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-tree.html new file mode 100644 index 00000000..11947604 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/org/shakespeareframework/reporting/package-tree.html @@ -0,0 +1,121 @@ + + + + +org.shakespeareframework.reporting Class Hierarchy (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.shakespeareframework.reporting

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/overview-summary.html b/docs/v0.8.1/javadoc/core/overview-summary.html new file mode 100644 index 00000000..4e6e03e7 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/overview-summary.html @@ -0,0 +1,25 @@ + + + + +core 0.8.1 API + + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/docs/v0.8.1/javadoc/core/overview-tree.html b/docs/v0.8.1/javadoc/core/overview-tree.html new file mode 100644 index 00000000..e2af3f39 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/overview-tree.html @@ -0,0 +1,145 @@ + + + + +Class Hierarchy (core 0.8.1 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+
+
+ + diff --git a/docs/v0.8.1/javadoc/core/package-search-index.js b/docs/v0.8.1/javadoc/core/package-search-index.js new file mode 100644 index 00000000..87cd9651 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.shakespeareframework"},{"l":"org.shakespeareframework.reporting"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/resources/glass.png b/docs/v0.8.1/javadoc/core/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/docs/v0.8.1/javadoc/core/resources/glass.png differ diff --git a/docs/v0.8.1/javadoc/core/resources/x.png b/docs/v0.8.1/javadoc/core/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/docs/v0.8.1/javadoc/core/resources/x.png differ diff --git a/docs/v0.8.1/javadoc/core/script-dir/jquery-3.6.1.min.js b/docs/v0.8.1/javadoc/core/script-dir/jquery-3.6.1.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
    ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
    ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
    ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
    ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/script.js b/docs/v0.8.1/javadoc/core/script.js new file mode 100644 index 00000000..73cd8faa --- /dev/null +++ b/docs/v0.8.1/javadoc/core/script.js @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor); + elem.classList.add(isEvenRow ? evenRowColor : oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} + +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + contentDiv.addEventListener("scroll", function(e) { + var timeoutID; + if (!timeoutID) { + timeoutID = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + timeoutID = null; + }, 100); + } + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/docs/v0.8.1/javadoc/core/search.js b/docs/v0.8.1/javadoc/core/search.js new file mode 100644 index 00000000..db3b2f4a --- /dev/null +++ b/docs/v0.8.1/javadoc/core/search.js @@ -0,0 +1,354 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Classes and Interfaces"; +var catMembers = "Members"; +var catSearchTags = "Search Tags"; +var highlight = "$&"; +var searchPattern = ""; +var fallbackPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MIN_RESULTS = 3; +var MAX_RESULTS = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher, fallbackMatcher) { + var escapedItem = escapeHtml(item); + var highlighted = escapedItem.replace(matcher, highlight); + if (highlighted === escapedItem) { + highlighted = escapedItem.replace(fallbackMatcher, highlight) + } + return highlighted; +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + } + return urlPrefix; +} +function createSearchPattern(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + var search = $("#search-input"); + var reset = $("#reset-button"); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + search.val(watermark).addClass('watermark'); + search.blur(function() { + if ($(this).val().length === 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + search.on('click keydown paste', function() { + if ($(this).val() === watermark) { + $(this).val('').removeClass('watermark'); + } + }); + reset.click(function() { + search.val('').focus(); + }); + search.focus()[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
  • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + var fallbackMatcher = new RegExp(fallbackPattern, "gi") + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags && item.h) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + var endOfName = leftParen > -1 ? leftParen : input.length; + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + searchPattern = createSearchPattern(request.term); + fallbackPattern = createSearchPattern(request.term.toLowerCase()); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var fallbackMatcher = new RegExp(fallbackPattern, "i"); + + function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) { + if (indexArray) { + var newResults = []; + $.each(indexArray, function (i, item) { + item.category = category; + var ranking = rankMatch(matcher.exec(nameFunc(item)), category); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ranking: ranking, item: item}); + } + return newResults.length <= MAX_RESULTS; + }); + return newResults.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }).map(function(e) { + return e.item; + }); + } + return []; + } + function searchIndex(indexArray, category, nameFunc) { + var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc); + result = result.concat(primaryResults); + if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) { + var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc); + result = result.concat(secondaryResults.filter(function (item) { + return primaryResults.indexOf(item) === -1; + })); + } + } + + searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; }); + searchIndex(packageSearchIndex, catPackages, function(item) { + return (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) : item.l; + }); + searchIndex(typeSearchIndex, catTypes, function(item) { + return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l; + }); + searchIndex(memberSearchIndex, catMembers, function(item) { + return request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l : item.l; + }); + searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; }); + + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search-input").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search-input").focus(); + } + } + }); +}); diff --git a/docs/v0.8.1/javadoc/core/serialized-form.html b/docs/v0.8.1/javadoc/core/serialized-form.html new file mode 100644 index 00000000..cbf142a1 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/serialized-form.html @@ -0,0 +1,102 @@ + + + + +Serialized Form (core 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/core/stylesheet.css b/docs/v0.8.1/javadoc/core/stylesheet.css new file mode 100644 index 00000000..4a576bd2 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/stylesheet.css @@ -0,0 +1,869 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; +} +h4 { + font-size:15px; +} +h5 { + font-size:14px; +} +h6 { + font-size:13px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +.summary-table dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0; + overflow:hidden; +} +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:11px; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + min-height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.sub-nav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.sub-nav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { + list-style:none; + float:left; + padding-top:10px; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.nav-bar-cell1-rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header and footer. + */ +.title { + color:#2c4557; + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.see-list, ul.see-list-long { + padding-left: 0; + list-style: none; +} +ul.see-list li { + display: inline; +} +ul.see-list li:not(:last-child):after, +ul.see-list-long li:not(:last-child):after { + content: ", "; + white-space: pre-wrap; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0; + padding-top:10px; + padding-left:1px; + margin:0; + white-space:pre; +} +.caption a:link, .caption a:visited { + color:#1f389c; +} +.caption a:hover, +.caption a:active { + color:#FFFFFF; +} +.caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +@media screen and (max-width: 800px) { + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-summary .col-last { + grid-column-end: span 2; + } +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:#dee3e9; + font-weight: bold; +} +.col-first, .col-first { + font-size:13px; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:13px; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited, +.constant-values-container a:link, .constant-values-container a:visited, +.all-classes-container a:link, .all-classes-container a:visited, +.all-packages-container a:link, .all-packages-container a:visited { + font-weight:bold; +} +.table-sub-heading-color { + background-color:#EEEEFF; +} +.even-row-color, .even-row-color .table-header { + background-color:#FFFFFF; +} +.odd-row-color, .odd-row-color .table-header { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.deprecated-content { + margin:0; + padding:10px 0; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:0 10px 5px 0; + color:#474747; +} +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset-button { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +span.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak font sizes and paddings for small screens. + */ +@media screen and (max-width: 1050px) { + #search-input { + width: 300px; + } +} +@media screen and (max-width: 800px) { + #search-input { + width: 200px; + } + .top-nav, + .bottom-nav { + font-size: 11px; + padding-top: 6px; + } + .sub-nav { + font-size: 11px; + } + .about-language { + padding-right: 16px; + } + ul.nav-list li, + .sub-nav .nav-list-search { + padding: 6px; + } + ul.sub-nav-list li { + padding-top: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 500px) { + #search-input { + width: 150px; + } + .top-nav, + .bottom-nav { + font-size: 10px; + } + .sub-nav { + font-size: 10px; + } + .about-language { + font-size: 10px; + padding-right: 12px; + } +} diff --git a/docs/v0.8.1/javadoc/core/tag-search-index.js b/docs/v0.8.1/javadoc/core/tag-search-index.js new file mode 100644 index 00000000..f38b3cb3 --- /dev/null +++ b/docs/v0.8.1/javadoc/core/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/core/type-search-index.js b/docs/v0.8.1/javadoc/core/type-search-index.js new file mode 100644 index 00000000..89b792cc --- /dev/null +++ b/docs/v0.8.1/javadoc/core/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"org.shakespeareframework","l":"Ability"},{"p":"org.shakespeareframework","l":"Actor"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.shakespeareframework","l":"Fact"},{"p":"org.shakespeareframework.reporting","l":"FileReporter"},{"p":"org.shakespeareframework.reporting","l":"LoggingReporter"},{"p":"org.shakespeareframework","l":"MissingAbilityException"},{"p":"org.shakespeareframework","l":"MissingFactException"},{"p":"org.shakespeareframework","l":"Question"},{"p":"org.shakespeareframework.reporting","l":"QuestionReporter"},{"p":"org.shakespeareframework.reporting","l":"Reporter"},{"p":"org.shakespeareframework.reporting","l":"FileReporter.ReportType"},{"p":"org.shakespeareframework","l":"Retryable"},{"p":"org.shakespeareframework","l":"RetryableQuestion"},{"p":"org.shakespeareframework","l":"RetryableTask"},{"p":"org.shakespeareframework","l":"RetryInterruptedException"},{"p":"org.shakespeareframework.reporting","l":"Slf4jReporter"},{"p":"org.shakespeareframework","l":"Task"},{"p":"org.shakespeareframework.reporting","l":"TaskReporter"},{"p":"org.shakespeareframework","l":"TimeoutException"},{"p":"org.shakespeareframework.reporting","l":"WriteReportFileException"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/allclasses-index.html b/docs/v0.8.1/javadoc/retrofit/allclasses-index.html new file mode 100644 index 00000000..b0141e7f --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/allclasses-index.html @@ -0,0 +1,100 @@ + + + + +All Classes and Interfaces (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Classes and Interfaces

    +
    +
    +
    +
    +
    +
    Class
    +
    Description
    + +
    +
    Ability to call RESTful APIs using Retrofit.
    +
    + +
    +
    Builder wrapping a Retrofit.Builder and a OkHttpClient.Builder to allow setting + both with one class.
    +
    + +
    +
    Interceptor to add headers to any request.
    +
    + +
    +
    An exception thrown when OAuth2 authentication fails.
    +
    + +
    +
    A parsed OAuth2 token.
    +
    + +
    +
    RetryingTokenAuthenticator to automatically authenticate with the Oauth2Api via + resource owner password + flow (grant type password) and add the access token as a header.
    +
    + +
    +
    Authenticator that will retry authentication at the #tokenServiceUrl for maxRetries times.
    +
    +
    +
    +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/allpackages-index.html b/docs/v0.8.1/javadoc/retrofit/allpackages-index.html new file mode 100644 index 00000000..b001ca73 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/allpackages-index.html @@ -0,0 +1,75 @@ + + + + +All Packages (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Packages

    +
    +
    Package Summary
    +
    +
    Package
    +
    Description
    + +
    +
    The retrofit package contains the CallHttpApis Ability, which enables an Actor to + call HTTP APIs using Retrofit generated clients.
    +
    + +
    +
    The authentication package contains Authenticators for OAuth 2.0 Authorization + flows: + + + ResourceOwnerPasswordTokenAuthenticator +
    +
    +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/element-list b/docs/v0.8.1/javadoc/retrofit/element-list new file mode 100644 index 00000000..d12695a6 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/element-list @@ -0,0 +1,2 @@ +org.shakespeareframework.retrofit +org.shakespeareframework.retrofit.oauth2 diff --git a/docs/v0.8.1/javadoc/retrofit/help-doc.html b/docs/v0.8.1/javadoc/retrofit/help-doc.html new file mode 100644 index 00000000..bc6e617f --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/help-doc.html @@ -0,0 +1,180 @@ + + + + +API Help (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +

    JavaDoc Help

    + +
    +
    +

    Navigation

    +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
    +
    +
    +

    Kinds of Pages

    +The following sections describe the different kinds of pages in this collection. +
    +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    +
    +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

    +
      +
    • Interfaces
    • +
    • Classes
    • +
    • Enum Classes
    • +
    • Exceptions
    • +
    • Errors
    • +
    • Annotation Interfaces
    • +
    +
    +
    +

    Class or Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

    +
      +
    • Class Inheritance Diagram
    • +
    • Direct Subclasses
    • +
    • All Known Subinterfaces
    • +
    • All Known Implementing Classes
    • +
    • Class or Interface Declaration
    • +
    • Class or Interface Description
    • +
    +
    +
      +
    • Nested Class Summary
    • +
    • Enum Constant Summary
    • +
    • Field Summary
    • +
    • Property Summary
    • +
    • Constructor Summary
    • +
    • Method Summary
    • +
    • Required Element Summary
    • +
    • Optional Element Summary
    • +
    +
    +
      +
    • Enum Constant Details
    • +
    • Field Details
    • +
    • Property Details
    • +
    • Constructor Details
    • +
    • Method Details
    • +
    • Element Details
    • +
    +

    Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

    +

    The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    +
    +

    Other Files

    +

    Packages and modules may contain pages with additional information related to the declarations nearby.

    +
    +
    +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
    • +
    • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
    • +
    +
    +
    +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

    +
    +
    +

    All Packages

    +

    The All Packages page contains an alphabetic index of all packages contained in the documentation.

    +
    +
    +

    All Classes and Interfaces

    +

    The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

    +
    +
    +

    Index

    +

    The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

    +
    +
    +
    +This help file applies to API documentation generated by the standard doclet.
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/index-all.html b/docs/v0.8.1/javadoc/retrofit/index-all.html new file mode 100644 index 00000000..9ae04a0d --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/index-all.html @@ -0,0 +1,200 @@ + + + + +Index (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Index

    +
    +A B C G H I O R 
    All Classes and Interfaces|All Packages|Serialized Form +

    A

    +
    +
    add(String, String) - Method in class org.shakespeareframework.retrofit.HeaderInterceptor
    +
    +
    Adds a header that will be added to the intercepted request.
    +
    +
    addConverterFactory(Converter.Factory) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Adds the given Converter.Factory to the CallHttpApis.Builder.retrofitBuilder.
    +
    +
    addInterceptor(Interceptor) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Adds the given Interceptor to the CallHttpApis.Builder.okHttpClientBuilder.
    +
    +
    addJacksonConverterFactory() - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Adds a JacksonConverterFactory to the CallHttpApis.Builder.retrofitBuilder.
    +
    +
    addJacksonConverterFactory(ObjectMapper) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Adds a JacksonConverterFactory using the given objectMapper to the CallHttpApis.Builder.retrofitBuilder.
    +
    +
    addScalarsConverterFactory() - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Adds a ScalarsConverterFactory to the CallHttpApis.Builder.retrofitBuilder.
    +
    +
    authenticate(Route, Response) - Method in class org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator
    +
     
    +
    authenticator(Authenticator) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Sets the Authenticator of the CallHttpApis.Builder.okHttpClientBuilder.
    +
    +
    +

    B

    +
    +
    baseUrl(String) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Sets the base URL to the CallHttpApis.Builder.retrofitBuilder.
    +
    +
    build(Class<? extends C>) - Method in class org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    Finalizes the build and returns the client.
    +
    +
    buildClient() - Method in class org.shakespeareframework.retrofit.CallHttpApis
    +
    +
    Creates a new CallHttpApis.Builder.
    +
    +
    +

    C

    +
    +
    CallHttpApis - Class in org.shakespeareframework.retrofit
    +
    +
    Ability to call RESTful APIs using Retrofit.
    +
    +
    CallHttpApis() - Constructor for class org.shakespeareframework.retrofit.CallHttpApis
    +
     
    +
    CallHttpApis.Builder - Class in org.shakespeareframework.retrofit
    +
    +
    Builder wrapping a Retrofit.Builder and a OkHttpClient.Builder to allow setting + both with one class.
    +
    +
    +

    G

    +
    +
    getAccessToken() - Method in class org.shakespeareframework.retrofit.oauth2.Oauth2Token
    +
     
    +
    getToken() - Method in class org.shakespeareframework.retrofit.oauth2.ResourceOwnerPasswordTokenAuthenticator
    +
     
    +
    getToken() - Method in class org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator
    +
     
    +
    +

    H

    +
    +
    HeaderInterceptor - Class in org.shakespeareframework.retrofit
    +
    +
    Interceptor to add headers to any request.
    +
    +
    HeaderInterceptor() - Constructor for class org.shakespeareframework.retrofit.HeaderInterceptor
    +
     
    +
    +

    I

    +
    +
    intercept(Interceptor.Chain) - Method in class org.shakespeareframework.retrofit.HeaderInterceptor
    +
     
    +
    isExpired() - Method in class org.shakespeareframework.retrofit.oauth2.Oauth2Token
    +
    +
    Checks if this is expired or will be expired in less than 10 seconds.
    +
    +
    +

    O

    +
    +
    oauth2Api - Variable in class org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator
    +
    +
    Oauth2Api instance to obtain a token.
    +
    +
    Oauth2AuthenticationFailedException - Exception in org.shakespeareframework.retrofit.oauth2
    +
    +
    An exception thrown when OAuth2 authentication fails.
    +
    +
    Oauth2AuthenticationFailedException() - Constructor for exception org.shakespeareframework.retrofit.oauth2.Oauth2AuthenticationFailedException
    +
     
    +
    Oauth2Token - Class in org.shakespeareframework.retrofit.oauth2
    +
    +
    A parsed OAuth2 token.
    +
    +
    Oauth2Token(String, Integer) - Constructor for class org.shakespeareframework.retrofit.oauth2.Oauth2Token
    +
     
    +
    org.shakespeareframework.retrofit - package org.shakespeareframework.retrofit
    +
    +
    The retrofit package contains the CallHttpApis Ability, which enables an Actor to + call HTTP APIs using Retrofit generated clients.
    +
    +
    org.shakespeareframework.retrofit.oauth2 - package org.shakespeareframework.retrofit.oauth2
    +
    +
    The authentication package contains Authenticators for OAuth 2.0 Authorization + flows: + + + ResourceOwnerPasswordTokenAuthenticator +
    +
    +
    +

    R

    +
    +
    remove(String) - Method in class org.shakespeareframework.retrofit.HeaderInterceptor
    +
    +
    Removes a header that will no longer be added to the intercepted request.
    +
    +
    ResourceOwnerPasswordTokenAuthenticator - Class in org.shakespeareframework.retrofit.oauth2
    +
    +
    RetryingTokenAuthenticator to automatically authenticate with the Oauth2Api via + resource owner password + flow (grant type password) and add the access token as a header.
    +
    +
    ResourceOwnerPasswordTokenAuthenticator(String, String, String, String, String, String) - Constructor for class org.shakespeareframework.retrofit.oauth2.ResourceOwnerPasswordTokenAuthenticator
    +
     
    +
    RetryingTokenAuthenticator - Class in org.shakespeareframework.retrofit.oauth2
    +
    +
    Authenticator that will retry authentication at the #tokenServiceUrl for maxRetries times.
    +
    +
    RetryingTokenAuthenticator(String, int) - Constructor for class org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator
    +
     
    +
    +A B C G H I O R 
    All Classes and Interfaces|All Packages|Serialized Form
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/index.html b/docs/v0.8.1/javadoc/retrofit/index.html new file mode 100644 index 00000000..32aab39e --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/index.html @@ -0,0 +1,77 @@ + + + + +Overview (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    retrofit 0.8.1 API

    +
    +
    +
    Packages
    +
    +
    Package
    +
    Description
    + +
    +
    The retrofit package contains the CallHttpApis Ability, which enables an Actor to + call HTTP APIs using Retrofit generated clients.
    +
    + +
    +
    The authentication package contains Authenticators for OAuth 2.0 Authorization + flows: + + + ResourceOwnerPasswordTokenAuthenticator +
    +
    +
    +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/jquery-ui.overrides.css b/docs/v0.8.1/javadoc/retrofit/jquery-ui.overrides.css new file mode 100644 index 00000000..facf852c --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/docs/v0.8.1/javadoc/retrofit/legal/ADDITIONAL_LICENSE_INFO b/docs/v0.8.1/javadoc/retrofit/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 00000000..ff700cd0 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/v0.8.1/javadoc/retrofit/legal/ASSEMBLY_EXCEPTION b/docs/v0.8.1/javadoc/retrofit/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 00000000..065b8d90 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/v0.8.1/javadoc/retrofit/legal/LICENSE b/docs/v0.8.1/javadoc/retrofit/legal/LICENSE new file mode 100644 index 00000000..8b400c7a --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/v0.8.1/javadoc/retrofit/legal/jquery.md b/docs/v0.8.1/javadoc/retrofit/legal/jquery.md new file mode 100644 index 00000000..d468b318 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/docs/v0.8.1/javadoc/retrofit/legal/jqueryUI.md b/docs/v0.8.1/javadoc/retrofit/legal/jqueryUI.md new file mode 100644 index 00000000..8bda9d7a --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/v0.8.1/javadoc/retrofit/member-search-index.js b/docs/v0.8.1/javadoc/retrofit/member-search-index.js new file mode 100644 index 00000000..bc8f9c3d --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.shakespeareframework.retrofit","c":"HeaderInterceptor","l":"add(String, String)","u":"add(java.lang.String,java.lang.String)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"addConverterFactory(Converter.Factory)","u":"addConverterFactory(retrofit2.Converter.Factory)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"addInterceptor(Interceptor)","u":"addInterceptor(okhttp3.Interceptor)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"addJacksonConverterFactory()"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"addJacksonConverterFactory(ObjectMapper)","u":"addJacksonConverterFactory(com.fasterxml.jackson.databind.ObjectMapper)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"addScalarsConverterFactory()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"RetryingTokenAuthenticator","l":"authenticate(Route, Response)","u":"authenticate(okhttp3.Route,okhttp3.Response)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"authenticator(Authenticator)","u":"authenticator(okhttp3.Authenticator)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"baseUrl(String)","u":"baseUrl(java.lang.String)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis.Builder","l":"build(Class)","u":"build(java.lang.Class)"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis","l":"buildClient()"},{"p":"org.shakespeareframework.retrofit","c":"CallHttpApis","l":"CallHttpApis()","u":"%3Cinit%3E()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"Oauth2Token","l":"getAccessToken()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"ResourceOwnerPasswordTokenAuthenticator","l":"getToken()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"RetryingTokenAuthenticator","l":"getToken()"},{"p":"org.shakespeareframework.retrofit","c":"HeaderInterceptor","l":"HeaderInterceptor()","u":"%3Cinit%3E()"},{"p":"org.shakespeareframework.retrofit","c":"HeaderInterceptor","l":"intercept(Interceptor.Chain)","u":"intercept(okhttp3.Interceptor.Chain)"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"Oauth2Token","l":"isExpired()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"RetryingTokenAuthenticator","l":"oauth2Api"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"Oauth2AuthenticationFailedException","l":"Oauth2AuthenticationFailedException()","u":"%3Cinit%3E()"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"Oauth2Token","l":"Oauth2Token(String, Integer)","u":"%3Cinit%3E(java.lang.String,java.lang.Integer)"},{"p":"org.shakespeareframework.retrofit","c":"HeaderInterceptor","l":"remove(String)","u":"remove(java.lang.String)"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"ResourceOwnerPasswordTokenAuthenticator","l":"ResourceOwnerPasswordTokenAuthenticator(String, String, String, String, String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.shakespeareframework.retrofit.oauth2","c":"RetryingTokenAuthenticator","l":"RetryingTokenAuthenticator(String, int)","u":"%3Cinit%3E(java.lang.String,int)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/module-search-index.js b/docs/v0.8.1/javadoc/retrofit/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.Builder.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.Builder.html new file mode 100644 index 00000000..03873412 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.Builder.html @@ -0,0 +1,322 @@ + + + + +CallHttpApis.Builder (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class CallHttpApis.Builder

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.CallHttpApis.Builder
    +
    +
    +
    +
    Enclosing class:
    +
    CallHttpApis
    +
    +
    +
    public static class CallHttpApis.Builder +extends Object
    +
    Builder wrapping a Retrofit.Builder and a OkHttpClient.Builder to allow setting + both with one class.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        baseUrl

        +
        public CallHttpApis.Builder baseUrl(String baseUrl)
        +
        Sets the base URL to the retrofitBuilder.
        +
        +
        Parameters:
        +
        baseUrl - base URL of the API
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        +
          +
        • Retrofit.Builder.baseUrl(String)
        • +
        +
        +
        +
        +
      • +
      • +
        +

        addConverterFactory

        +
        public CallHttpApis.Builder addConverterFactory(retrofit2.Converter.Factory converterFactory)
        +
        Adds the given Converter.Factory to the retrofitBuilder.
        +
        +
        Parameters:
        +
        converterFactory - a Converter.Factory to be added to the retrofitBuilder
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        +
          +
        • Retrofit.Builder.addConverterFactory(Converter.Factory)
        • +
        +
        +
        +
        +
      • +
      • +
        +

        addScalarsConverterFactory

        +
        public CallHttpApis.Builder addScalarsConverterFactory()
        +
        Adds a ScalarsConverterFactory to the retrofitBuilder.
        +
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        + +
        +
        +
        +
      • +
      • +
        +

        addJacksonConverterFactory

        +
        public CallHttpApis.Builder addJacksonConverterFactory()
        +
        Adds a JacksonConverterFactory to the retrofitBuilder.
        +
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        + +
        +
        +
        +
      • +
      • +
        +

        addJacksonConverterFactory

        +
        public CallHttpApis.Builder addJacksonConverterFactory(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        +
        Adds a JacksonConverterFactory using the given objectMapper to the retrofitBuilder.
        +
        +
        Parameters:
        +
        objectMapper - the ObjectMapper to be used by the JacksonConverterFactory
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        + +
        +
        +
        +
      • +
      • +
        +

        addInterceptor

        +
        public CallHttpApis.Builder addInterceptor(okhttp3.Interceptor interceptor)
        +
        Adds the given Interceptor to the okHttpClientBuilder.
        +
        +
        Parameters:
        +
        interceptor - an Interceptor to be added to the okHttpClientBuilder
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        +
          +
        • OkHttpClient.Builder.addInterceptor(Interceptor)
        • +
        +
        +
        +
        +
      • +
      • +
        +

        authenticator

        +
        public CallHttpApis.Builder authenticator(okhttp3.Authenticator authenticator)
        +
        Sets the Authenticator of the okHttpClientBuilder.
        +
        +
        Parameters:
        +
        authenticator - the Authenticator to be set
        +
        Returns:
        +
        the CallHttpApis.Builder
        +
        See Also:
        +
        +
          +
        • OkHttpClient.Builder.authenticator(Authenticator)
        • +
        +
        +
        +
        +
      • +
      • +
        +

        build

        +
        public <C> C build(Class<? extends C> clientClass)
        +
        Finalizes the build and returns the client.
        +
        +
        Type Parameters:
        +
        C - the type of the API client class
        +
        Parameters:
        +
        clientClass - the API client class
        +
        Returns:
        +
        an instance of clientClass to interact with the API
        +
        See Also:
        +
        +
          +
        • Retrofit.Builder.build()
        • +
        • OkHttpClient.Builder.build()
        • +
        • Retrofit.create(Class)
        • +
        +
        +
        +
        +
      • +
      +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.html new file mode 100644 index 00000000..c8c76c19 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/CallHttpApis.html @@ -0,0 +1,189 @@ + + + + +CallHttpApis (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class CallHttpApis

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.CallHttpApis
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    org.shakespeareframework.Ability
    +
    +
    +
    @NullMarked +public class CallHttpApis +extends Object +implements org.shakespeareframework.Ability
    +
    Ability to call RESTful APIs using Retrofit.
    +
    +
    + +
    +
    + +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/HeaderInterceptor.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/HeaderInterceptor.html new file mode 100644 index 00000000..3c6ed391 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/HeaderInterceptor.html @@ -0,0 +1,226 @@ + + + + +HeaderInterceptor (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class HeaderInterceptor

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.HeaderInterceptor
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    okhttp3.Interceptor
    +
    +
    +
    @NullMarked +public class HeaderInterceptor +extends Object +implements okhttp3.Interceptor
    +
    Interceptor to add headers to any request. This should be used to set authentication or + other contextual headers.
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from interface okhttp3.Interceptor

      +okhttp3.Interceptor.Chain, okhttp3.Interceptor.Companion
      +
      +
    • + +
    • +
      +

      Field Summary

      +
      +

      Fields inherited from interface okhttp3.Interceptor

      +Companion
      +
      +
    • + +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      + +
       
      +
      +
      +
    • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      add(String key, + String value)
      +
      +
      Adds a header that will be added to the intercepted request.
      +
      +
      okhttp3.Response
      +
      intercept(okhttp3.Interceptor.Chain chain)
      +
       
      +
      void
      + +
      +
      Removes a header that will no longer be added to the intercepted request.
      +
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        HeaderInterceptor

        +
        public HeaderInterceptor()
        +
        +
      • +
      +
      +
    • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        intercept

        +
        @Nonnull +public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) + throws IOException
        +
        +
        Specified by:
        +
        intercept in interface okhttp3.Interceptor
        +
        Throws:
        +
        IOException
        +
        +
        +
      • +
      • +
        +

        add

        +
        public void add(String key, + String value)
        +
        Adds a header that will be added to the intercepted request.
        +
        +
        Parameters:
        +
        key - name of the header to be added
        +
        value - value of the header to be added
        +
        +
        +
      • +
      • +
        +

        remove

        +
        public void remove(String key)
        +
        Removes a header that will no longer be added to the intercepted request.
        +
        +
        Parameters:
        +
        key - name of the header to be removed
        +
        +
        +
      • +
      +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2AuthenticationFailedException.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2AuthenticationFailedException.html new file mode 100644 index 00000000..80cd23c5 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2AuthenticationFailedException.html @@ -0,0 +1,148 @@ + + + + +Oauth2AuthenticationFailedException (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class Oauth2AuthenticationFailedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.lang.RuntimeException +
    org.shakespeareframework.retrofit.oauth2.Oauth2AuthenticationFailedException
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    public class Oauth2AuthenticationFailedException +extends RuntimeException
    +
    An exception thrown when OAuth2 authentication fails.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        Oauth2AuthenticationFailedException

        +
        public Oauth2AuthenticationFailedException()
        +
        +
      • +
      +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2Token.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2Token.html new file mode 100644 index 00000000..ef4798c2 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/Oauth2Token.html @@ -0,0 +1,185 @@ + + + + +Oauth2Token (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class Oauth2Token

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.oauth2.Oauth2Token
    +
    +
    +
    +
    public class Oauth2Token +extends Object
    +
    A parsed OAuth2 token.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        Oauth2Token

        +
        public Oauth2Token(String accessToken, + Integer expiresIn)
        +
        +
        Parameters:
        +
        accessToken - the access token String for the Authorization header
        +
        expiresIn - number of seconds before the token expires
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        isExpired

        +
        public boolean isExpired()
        +
        Checks if this is expired or will be expired in less than 10 seconds.
        +
        +
        Returns:
        +
        true, this is expired or will be expired in less than 10 seconds
        +
        +
        +
      • +
      • +
        +

        getAccessToken

        +
        public String getAccessToken()
        +
        +
        Returns:
        +
        the access token String for the Authorization header
        +
        +
        +
      • +
      +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/ResourceOwnerPasswordTokenAuthenticator.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/ResourceOwnerPasswordTokenAuthenticator.html new file mode 100644 index 00000000..e95a4317 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/ResourceOwnerPasswordTokenAuthenticator.html @@ -0,0 +1,217 @@ + + + + +ResourceOwnerPasswordTokenAuthenticator (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class ResourceOwnerPasswordTokenAuthenticator

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator +
    org.shakespeareframework.retrofit.oauth2.ResourceOwnerPasswordTokenAuthenticator
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    okhttp3.Authenticator
    +
    +
    +
    public class ResourceOwnerPasswordTokenAuthenticator +extends RetryingTokenAuthenticator
    +
    RetryingTokenAuthenticator to automatically authenticate with the Oauth2Api via + resource owner password + flow (grant type password) and add the access token as a header. + +

    Also note that refresh tokens are currently ignored!

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ResourceOwnerPasswordTokenAuthenticator

        +
        public ResourceOwnerPasswordTokenAuthenticator(String tokenServiceUrl, + String username, + String password, + String clientId, + String clientSecret, + String scope)
        +
        +
        Parameters:
        +
        tokenServiceUrl - the URl of the token service.
        +
        username - the username
        +
        password - the password
        +
        clientId - the client ID
        +
        clientSecret - the client secret
        +
        scope - the scope
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      +

      Method Details

      + +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/RetryingTokenAuthenticator.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/RetryingTokenAuthenticator.html new file mode 100644 index 00000000..e64fdada --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/RetryingTokenAuthenticator.html @@ -0,0 +1,242 @@ + + + + +RetryingTokenAuthenticator (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    + +

    Class RetryingTokenAuthenticator

    +
    +
    java.lang.Object +
    org.shakespeareframework.retrofit.oauth2.RetryingTokenAuthenticator
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    okhttp3.Authenticator
    +
    +
    +
    Direct Known Subclasses:
    +
    ResourceOwnerPasswordTokenAuthenticator
    +
    +
    +
    public abstract class RetryingTokenAuthenticator +extends Object +implements okhttp3.Authenticator
    +
    Authenticator that will retry authentication at the #tokenServiceUrl for maxRetries times.
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from interface okhttp3.Authenticator

      +okhttp3.Authenticator.Companion
      +
      +
    • + +
    • +
      +

      Field Summary

      +
      Fields
      +
      +
      Modifier and Type
      +
      Field
      +
      Description
      +
      protected final org.shakespeareframework.retrofit.oauth2.Oauth2Api
      + +
      +
      Oauth2Api instance to obtain a token.
      +
      +
      +
      +

      Fields inherited from interface okhttp3.Authenticator

      +Companion, JAVA_NET_AUTHENTICATOR, NONE
      +
      +
    • + +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Modifier
      +
      Constructor
      +
      Description
      +
      protected
      +
      RetryingTokenAuthenticator(String tokenServiceUrl, + int maxRetries)
      +
       
      +
      +
      +
    • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      okhttp3.Request
      +
      authenticate(okhttp3.Route route, + okhttp3.Response response)
      +
       
      +
      protected abstract Oauth2Token
      + +
       
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        oauth2Api

        +
        protected final org.shakespeareframework.retrofit.oauth2.Oauth2Api oauth2Api
        +
        Oauth2Api instance to obtain a token.
        +
        +
      • +
      +
      +
    • + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        RetryingTokenAuthenticator

        +
        protected RetryingTokenAuthenticator(String tokenServiceUrl, + int maxRetries)
        +
        +
        Parameters:
        +
        tokenServiceUrl - the URl of the token service.
        +
        maxRetries - maximum number of retries.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        authenticate

        +
        @Nullable +public okhttp3.Request authenticate(@Nullable + okhttp3.Route route, + @Nonnull + okhttp3.Response response)
        +
        +
        Specified by:
        +
        authenticate in interface okhttp3.Authenticator
        +
        +
        +
      • +
      • +
        +

        getToken

        +
        protected abstract Oauth2Token getToken()
        +
        +
        Returns:
        +
        a valid token
        +
        +
        +
      • +
      +
      +
    • +
    +
    + +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-summary.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-summary.html new file mode 100644 index 00000000..462deea8 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-summary.html @@ -0,0 +1,134 @@ + + + + +org.shakespeareframework.retrofit.oauth2 (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.shakespeareframework.retrofit.oauth2

    +
    +
    +
    package org.shakespeareframework.retrofit.oauth2
    +
    +
    The authentication package contains Authenticators for OAuth 2.0 Authorization + flows: + +
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-tree.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-tree.html new file mode 100644 index 00000000..07f5b24d --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/oauth2/package-tree.html @@ -0,0 +1,88 @@ + + + + +org.shakespeareframework.retrofit.oauth2 Class Hierarchy (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.shakespeareframework.retrofit.oauth2

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-summary.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-summary.html new file mode 100644 index 00000000..eca54c27 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-summary.html @@ -0,0 +1,127 @@ + + + + +org.shakespeareframework.retrofit (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.shakespeareframework.retrofit

    +
    +
    +
    package org.shakespeareframework.retrofit
    +
    +
    The retrofit package contains the CallHttpApis Ability, which enables an Actor to + call HTTP APIs using Retrofit generated clients. + +

    Additionally the HeaderInterceptor can be used via + CallHttpApis.Builder.addInterceptor(okhttp3.Interceptor) to add standard + headers that will be added to any request. E.g. to add authentication headers.

    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-tree.html b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-tree.html new file mode 100644 index 00000000..254853d2 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/org/shakespeareframework/retrofit/package-tree.html @@ -0,0 +1,72 @@ + + + + +org.shakespeareframework.retrofit Class Hierarchy (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.shakespeareframework.retrofit

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/overview-summary.html b/docs/v0.8.1/javadoc/retrofit/overview-summary.html new file mode 100644 index 00000000..78476ef5 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/overview-summary.html @@ -0,0 +1,25 @@ + + + + +retrofit 0.8.1 API + + + + + + + + + + +
    + +

    index.html

    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/overview-tree.html b/docs/v0.8.1/javadoc/retrofit/overview-tree.html new file mode 100644 index 00000000..4d0b73d7 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/overview-tree.html @@ -0,0 +1,92 @@ + + + + +Class Hierarchy (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +
    +
    +
    +
    + + diff --git a/docs/v0.8.1/javadoc/retrofit/package-search-index.js b/docs/v0.8.1/javadoc/retrofit/package-search-index.js new file mode 100644 index 00000000..6da0dcfa --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.shakespeareframework.retrofit"},{"l":"org.shakespeareframework.retrofit.oauth2"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/resources/glass.png b/docs/v0.8.1/javadoc/retrofit/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/docs/v0.8.1/javadoc/retrofit/resources/glass.png differ diff --git a/docs/v0.8.1/javadoc/retrofit/resources/x.png b/docs/v0.8.1/javadoc/retrofit/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/docs/v0.8.1/javadoc/retrofit/resources/x.png differ diff --git a/docs/v0.8.1/javadoc/retrofit/script-dir/jquery-3.6.1.min.js b/docs/v0.8.1/javadoc/retrofit/script-dir/jquery-3.6.1.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
    "),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
      ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
      ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
      ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
      ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/script.js b/docs/v0.8.1/javadoc/retrofit/script.js new file mode 100644 index 00000000..73cd8faa --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/script.js @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor); + elem.classList.add(isEvenRow ? evenRowColor : oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} + +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + contentDiv.addEventListener("scroll", function(e) { + var timeoutID; + if (!timeoutID) { + timeoutID = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + timeoutID = null; + }, 100); + } + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/docs/v0.8.1/javadoc/retrofit/search.js b/docs/v0.8.1/javadoc/retrofit/search.js new file mode 100644 index 00000000..db3b2f4a --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/search.js @@ -0,0 +1,354 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Classes and Interfaces"; +var catMembers = "Members"; +var catSearchTags = "Search Tags"; +var highlight = "$&"; +var searchPattern = ""; +var fallbackPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MIN_RESULTS = 3; +var MAX_RESULTS = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher, fallbackMatcher) { + var escapedItem = escapeHtml(item); + var highlighted = escapedItem.replace(matcher, highlight); + if (highlighted === escapedItem) { + highlighted = escapedItem.replace(fallbackMatcher, highlight) + } + return highlighted; +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + } + return urlPrefix; +} +function createSearchPattern(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + var search = $("#search-input"); + var reset = $("#reset-button"); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + search.val(watermark).addClass('watermark'); + search.blur(function() { + if ($(this).val().length === 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + search.on('click keydown paste', function() { + if ($(this).val() === watermark) { + $(this).val('').removeClass('watermark'); + } + }); + reset.click(function() { + search.val('').focus(); + }); + search.focus()[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("
    • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + var fallbackMatcher = new RegExp(fallbackPattern, "gi") + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else { + label = item.l; + } + var li = $("
    • ").appendTo(ul); + var div = $("
      ").appendTo(li); + if (item.category === catSearchTags && item.h) { + if (item.d) { + div.html(label + " (" + item.h + ")
      " + + item.d + "
      "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + var endOfName = leftParen > -1 ? leftParen : input.length; + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + searchPattern = createSearchPattern(request.term); + fallbackPattern = createSearchPattern(request.term.toLowerCase()); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var fallbackMatcher = new RegExp(fallbackPattern, "i"); + + function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) { + if (indexArray) { + var newResults = []; + $.each(indexArray, function (i, item) { + item.category = category; + var ranking = rankMatch(matcher.exec(nameFunc(item)), category); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ranking: ranking, item: item}); + } + return newResults.length <= MAX_RESULTS; + }); + return newResults.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }).map(function(e) { + return e.item; + }); + } + return []; + } + function searchIndex(indexArray, category, nameFunc) { + var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc); + result = result.concat(primaryResults); + if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) { + var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc); + result = result.concat(secondaryResults.filter(function (item) { + return primaryResults.indexOf(item) === -1; + })); + } + } + + searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; }); + searchIndex(packageSearchIndex, catPackages, function(item) { + return (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) : item.l; + }); + searchIndex(typeSearchIndex, catTypes, function(item) { + return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l; + }); + searchIndex(memberSearchIndex, catMembers, function(item) { + return request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l : item.l; + }); + searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; }); + + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search-input").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search-input").focus(); + } + } + }); +}); diff --git a/docs/v0.8.1/javadoc/retrofit/serialized-form.html b/docs/v0.8.1/javadoc/retrofit/serialized-form.html new file mode 100644 index 00000000..bd066ff1 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/serialized-form.html @@ -0,0 +1,71 @@ + + + + +Serialized Form (retrofit 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Serialized Form

      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/retrofit/stylesheet.css b/docs/v0.8.1/javadoc/retrofit/stylesheet.css new file mode 100644 index 00000000..4a576bd2 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/stylesheet.css @@ -0,0 +1,869 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; +} +h4 { + font-size:15px; +} +h5 { + font-size:14px; +} +h6 { + font-size:13px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +.summary-table dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0; + overflow:hidden; +} +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:11px; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + min-height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.sub-nav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.sub-nav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { + list-style:none; + float:left; + padding-top:10px; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.nav-bar-cell1-rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header and footer. + */ +.title { + color:#2c4557; + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.see-list, ul.see-list-long { + padding-left: 0; + list-style: none; +} +ul.see-list li { + display: inline; +} +ul.see-list li:not(:last-child):after, +ul.see-list-long li:not(:last-child):after { + content: ", "; + white-space: pre-wrap; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0; + padding-top:10px; + padding-left:1px; + margin:0; + white-space:pre; +} +.caption a:link, .caption a:visited { + color:#1f389c; +} +.caption a:hover, +.caption a:active { + color:#FFFFFF; +} +.caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +@media screen and (max-width: 800px) { + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-summary .col-last { + grid-column-end: span 2; + } +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:#dee3e9; + font-weight: bold; +} +.col-first, .col-first { + font-size:13px; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:13px; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited, +.constant-values-container a:link, .constant-values-container a:visited, +.all-classes-container a:link, .all-classes-container a:visited, +.all-packages-container a:link, .all-packages-container a:visited { + font-weight:bold; +} +.table-sub-heading-color { + background-color:#EEEEFF; +} +.even-row-color, .even-row-color .table-header { + background-color:#FFFFFF; +} +.odd-row-color, .odd-row-color .table-header { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.deprecated-content { + margin:0; + padding:10px 0; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:0 10px 5px 0; + color:#474747; +} +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset-button { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +span.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak font sizes and paddings for small screens. + */ +@media screen and (max-width: 1050px) { + #search-input { + width: 300px; + } +} +@media screen and (max-width: 800px) { + #search-input { + width: 200px; + } + .top-nav, + .bottom-nav { + font-size: 11px; + padding-top: 6px; + } + .sub-nav { + font-size: 11px; + } + .about-language { + padding-right: 16px; + } + ul.nav-list li, + .sub-nav .nav-list-search { + padding: 6px; + } + ul.sub-nav-list li { + padding-top: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 500px) { + #search-input { + width: 150px; + } + .top-nav, + .bottom-nav { + font-size: 10px; + } + .sub-nav { + font-size: 10px; + } + .about-language { + font-size: 10px; + padding-right: 12px; + } +} diff --git a/docs/v0.8.1/javadoc/retrofit/tag-search-index.js b/docs/v0.8.1/javadoc/retrofit/tag-search-index.js new file mode 100644 index 00000000..f38b3cb3 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/retrofit/type-search-index.js b/docs/v0.8.1/javadoc/retrofit/type-search-index.js new file mode 100644 index 00000000..f6dcdbc5 --- /dev/null +++ b/docs/v0.8.1/javadoc/retrofit/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.shakespeareframework.retrofit","l":"CallHttpApis.Builder"},{"p":"org.shakespeareframework.retrofit","l":"CallHttpApis"},{"p":"org.shakespeareframework.retrofit","l":"HeaderInterceptor"},{"p":"org.shakespeareframework.retrofit.oauth2","l":"Oauth2AuthenticationFailedException"},{"p":"org.shakespeareframework.retrofit.oauth2","l":"Oauth2Token"},{"p":"org.shakespeareframework.retrofit.oauth2","l":"ResourceOwnerPasswordTokenAuthenticator"},{"p":"org.shakespeareframework.retrofit.oauth2","l":"RetryingTokenAuthenticator"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/allclasses-index.html b/docs/v0.8.1/javadoc/selenium/allclasses-index.html new file mode 100644 index 00000000..a451b69f --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/allclasses-index.html @@ -0,0 +1,106 @@ + + + + +All Classes and Interfaces (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      All Classes and Interfaces

      +
      +
      +
      +
      +
      +
      Class
      +
      Description
      + +
      +
      Enum of all browser types which are supported by WebDriverSupplier.
      +
      + +
      +
      Ability to browse the web using a Selenium WebDriver.
      +
      + +
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() to take an HTML snapshot + of the currently displayed site.
      +
      + +
      +
      A WebDriverSupplier for locally installed browser instances.
      +
      + +
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() as TakesScreenshot + to take a screenshot of the currently displayed site.
      +
      + +
      +
      RuntimeException to be thrown when the given string did not match any BrowserType.
      +
      + +
      +
      A WebDriverSupplier based on WebDriverManager.
      +
      + +
      +
      RuntimeException to be thrown when a WebDriverSupplier failed to setup the WebDriver.
      +
      + +
      +
      A Supplier for WebDriver, which also takes care of quitting the WebDriver.
      +
      +
      +
      +
      +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/allpackages-index.html b/docs/v0.8.1/javadoc/selenium/allpackages-index.html new file mode 100644 index 00000000..e5c327fd --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/allpackages-index.html @@ -0,0 +1,64 @@ + + + + +All Packages (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      All Packages

      +
      +
      Package Summary
      +
      +
      Package
      +
      Description
      + +
      +
      The central class of the selenium package is the BrowseTheWeb Ability, which requires a WebDriverSupplier to be instantiated.
      +
      +
      +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/element-list b/docs/v0.8.1/javadoc/selenium/element-list new file mode 100644 index 00000000..ead3e912 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/element-list @@ -0,0 +1 @@ +org.shakespeareframework.selenium diff --git a/docs/v0.8.1/javadoc/selenium/help-doc.html b/docs/v0.8.1/javadoc/selenium/help-doc.html new file mode 100644 index 00000000..a47c48dd --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/help-doc.html @@ -0,0 +1,174 @@ + + + + +API Help (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +

      JavaDoc Help

      + +
      +
      +

      Navigation

      +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
        +
      • Interfaces
      • +
      • Classes
      • +
      • Enum Classes
      • +
      • Exceptions
      • +
      • Errors
      • +
      • Annotation Interfaces
      • +
      +
      +
      +

      Class or Interface

      +

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

      +
        +
      • Class Inheritance Diagram
      • +
      • Direct Subclasses
      • +
      • All Known Subinterfaces
      • +
      • All Known Implementing Classes
      • +
      • Class or Interface Declaration
      • +
      • Class or Interface Description
      • +
      +
      +
        +
      • Nested Class Summary
      • +
      • Enum Constant Summary
      • +
      • Field Summary
      • +
      • Property Summary
      • +
      • Constructor Summary
      • +
      • Method Summary
      • +
      • Required Element Summary
      • +
      • Optional Element Summary
      • +
      +
      +
        +
      • Enum Constant Details
      • +
      • Field Details
      • +
      • Property Details
      • +
      • Constructor Details
      • +
      • Method Details
      • +
      • Element Details
      • +
      +

      Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

      +

      The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

      +
      +
      +

      Other Files

      +

      Packages and modules may contain pages with additional information related to the declarations nearby.

      +
      +
      +

      Tree (Class Hierarchy)

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

      +
        +
      • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
      • +
      • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
      • +
      +
      +
      +

      Serialized Form

      +

      Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

      +
      +
      +

      All Packages

      +

      The All Packages page contains an alphabetic index of all packages contained in the documentation.

      +
      +
      +

      All Classes and Interfaces

      +

      The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

      +
      +
      +

      Index

      +

      The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

      +
      +
      +
      +This help file applies to API documentation generated by the standard doclet.
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/index-all.html b/docs/v0.8.1/javadoc/selenium/index-all.html new file mode 100644 index 00000000..1bc3b2ec --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/index-all.html @@ -0,0 +1,270 @@ + + + + +Index (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Index

      +
      +B C E F G H I L O R S T U V W 
      All Classes and Interfaces|All Packages|Serialized Form +

      B

      +
      +
      BrowserType - Enum Class in org.shakespeareframework.selenium
      +
      +
      Enum of all browser types which are supported by WebDriverSupplier.
      +
      +
      BrowseTheWeb - Class in org.shakespeareframework.selenium
      +
      +
      Ability to browse the web using a Selenium WebDriver.
      +
      +
      BrowseTheWeb(WebDriverSupplier) - Constructor for class org.shakespeareframework.selenium.BrowseTheWeb
      +
       
      +
      BrowseTheWeb(WebDriverSupplier, String) - Constructor for class org.shakespeareframework.selenium.BrowseTheWeb
      +
       
      +
      +

      C

      +
      +
      CHROME - Enum constant in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Google Chrome
      +
      +
      close() - Method in class org.shakespeareframework.selenium.BrowseTheWeb
      +
       
      +
      close() - Method in class org.shakespeareframework.selenium.WebDriverManagerWebDriverSupplier
      +
       
      +
      +

      E

      +
      +
      EDGE - Enum constant in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Microsoft Edge
      +
      +
      +

      F

      +
      +
      failure(Actor, Question<?>, Exception) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      failure(Actor, Question<?>, Exception) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      failure(Actor, Question<A>, A) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      failure(Actor, Question<A>, A) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      failure(Actor, Task, Exception) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      failure(Actor, Task, Exception) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      FIREFOX - Enum constant in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Mozilla Firefox
      +
      +
      forName(String) - Static method in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Looks up the named BrowserType, ignoring case.
      +
      +
      +

      G

      +
      +
      get() - Method in class org.shakespeareframework.selenium.WebDriverManagerWebDriverSupplier
      +
       
      +
      getBaseCapabilities() - Method in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Returns the base Capabilities of the BrowserType.
      +
      +
      getBrowserType() - Method in class org.shakespeareframework.selenium.WebDriverSupplier
      +
      + +
      +
      getCapabilities() - Method in class org.shakespeareframework.selenium.WebDriverSupplier
      +
      +
      Returns the Capabilities for the WebDriver, merged from the BrowserType's baseCapabilities and additional capabilities.
      +
      +
      getWebDriver() - Method in class org.shakespeareframework.selenium.BrowseTheWeb
      +
      +
      Gets the WebDriver from the BrowseTheWeb.webDriverSupplier and returns it.
      +
      +
      getWebDriverClass() - Method in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Returns the WebDriver Class required to automate the BrowserType.
      +
      +
      +

      H

      +
      +
      HtmlSnapshotReporter - Class in org.shakespeareframework.selenium
      +
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() to take an HTML snapshot + of the currently displayed site.
      +
      +
      HtmlSnapshotReporter(Path) - Constructor for class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
      +
      Sets HtmlSnapshotReporter.reportSuccess to false.
      +
      +
      HtmlSnapshotReporter(Path, boolean) - Constructor for class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      +

      I

      +
      +
      IEXPLORER - Enum constant in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Microsoft Internet Explorer
      +
      +
      +

      L

      +
      +
      LocalWebDriverSupplier - Class in org.shakespeareframework.selenium
      +
      +
      A WebDriverSupplier for locally installed browser instances.
      +
      +
      LocalWebDriverSupplier(BrowserType) - Constructor for class org.shakespeareframework.selenium.LocalWebDriverSupplier
      +
       
      +
      LocalWebDriverSupplier(BrowserType, Capabilities) - Constructor for class org.shakespeareframework.selenium.LocalWebDriverSupplier
      +
       
      +
      +

      O

      +
      +
      org.shakespeareframework.selenium - package org.shakespeareframework.selenium
      +
      +
      The central class of the selenium package is the BrowseTheWeb Ability, which requires a WebDriverSupplier to be instantiated.
      +
      +
      +

      R

      +
      +
      retry(Actor, RetryableQuestion<?>, Exception) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      retry(Actor, RetryableQuestion<?>, Exception) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      retry(Actor, RetryableQuestion<A>, A) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      retry(Actor, RetryableQuestion<A>, A) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      retry(Actor, RetryableTask, Exception) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      retry(Actor, RetryableTask, Exception) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      +

      S

      +
      +
      SAFARI - Enum constant in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Apple Safari
      +
      +
      ScreenshotReporter - Class in org.shakespeareframework.selenium
      +
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() as TakesScreenshot + to take a screenshot of the currently displayed site.
      +
      +
      ScreenshotReporter(Path) - Constructor for class org.shakespeareframework.selenium.ScreenshotReporter
      +
      +
      Sets ScreenshotReporter.reportSuccess to false.
      +
      +
      ScreenshotReporter(Path, boolean) - Constructor for class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      success(Actor, Question<A>, A) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      success(Actor, Question<A>, A) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      success(Actor, Task) - Method in class org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
       
      +
      success(Actor, Task) - Method in class org.shakespeareframework.selenium.ScreenshotReporter
      +
       
      +
      +

      T

      +
      +
      toString() - Method in class org.shakespeareframework.selenium.BrowseTheWeb
      +
       
      +
      toString() - Method in class org.shakespeareframework.selenium.WebDriverSupplier
      +
       
      +
      +

      U

      +
      +
      UnsupportedBrowserTypeException - Exception in org.shakespeareframework.selenium
      +
      +
      RuntimeException to be thrown when the given string did not match any BrowserType.
      +
      +
      UnsupportedBrowserTypeException(String) - Constructor for exception org.shakespeareframework.selenium.UnsupportedBrowserTypeException
      +
       
      +
      +

      V

      +
      +
      valueOf(String) - Static method in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      values() - Static method in enum class org.shakespeareframework.selenium.BrowserType
      +
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      +

      W

      +
      +
      WebDriverManagerWebDriverSupplier - Class in org.shakespeareframework.selenium
      +
      +
      A WebDriverSupplier based on WebDriverManager.
      +
      +
      WebDriverManagerWebDriverSupplier(WebDriverManager, BrowserType) - Constructor for class org.shakespeareframework.selenium.WebDriverManagerWebDriverSupplier
      +
       
      +
      WebDriverManagerWebDriverSupplier(WebDriverManager, BrowserType, Capabilities) - Constructor for class org.shakespeareframework.selenium.WebDriverManagerWebDriverSupplier
      +
       
      +
      WebDriverSetupFailedException - Exception in org.shakespeareframework.selenium
      +
      +
      RuntimeException to be thrown when a WebDriverSupplier failed to setup the WebDriver.
      +
      +
      WebDriverSetupFailedException(Exception) - Constructor for exception org.shakespeareframework.selenium.WebDriverSetupFailedException
      +
       
      +
      WebDriverSupplier - Class in org.shakespeareframework.selenium
      +
      +
      A Supplier for WebDriver, which also takes care of quitting the WebDriver.
      +
      +
      WebDriverSupplier(BrowserType, Capabilities) - Constructor for class org.shakespeareframework.selenium.WebDriverSupplier
      +
      +
      Creates a WebDriverSupplier for the given BrowserType with additional Capabilities that will be merged with the BrowserType's baseCapabilities.
      +
      +
      +B C E F G H I L O R S T U V W 
      All Classes and Interfaces|All Packages|Serialized Form
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/index.html b/docs/v0.8.1/javadoc/selenium/index.html new file mode 100644 index 00000000..771229fb --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/index.html @@ -0,0 +1,25 @@ + + + + +selenium 0.8.1 API + + + + + + + + + + +
      + +

      org/shakespeareframework/selenium/package-summary.html

      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/jquery-ui.overrides.css b/docs/v0.8.1/javadoc/selenium/jquery-ui.overrides.css new file mode 100644 index 00000000..facf852c --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/docs/v0.8.1/javadoc/selenium/legal/ADDITIONAL_LICENSE_INFO b/docs/v0.8.1/javadoc/selenium/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 00000000..ff700cd0 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/v0.8.1/javadoc/selenium/legal/ASSEMBLY_EXCEPTION b/docs/v0.8.1/javadoc/selenium/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 00000000..065b8d90 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/v0.8.1/javadoc/selenium/legal/LICENSE b/docs/v0.8.1/javadoc/selenium/legal/LICENSE new file mode 100644 index 00000000..8b400c7a --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/v0.8.1/javadoc/selenium/legal/jquery.md b/docs/v0.8.1/javadoc/selenium/legal/jquery.md new file mode 100644 index 00000000..d468b318 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/docs/v0.8.1/javadoc/selenium/legal/jqueryUI.md b/docs/v0.8.1/javadoc/selenium/legal/jqueryUI.md new file mode 100644 index 00000000..8bda9d7a --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/v0.8.1/javadoc/selenium/member-search-index.js b/docs/v0.8.1/javadoc/selenium/member-search-index.js new file mode 100644 index 00000000..65897730 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.shakespeareframework.selenium","c":"BrowseTheWeb","l":"BrowseTheWeb(WebDriverSupplier)","u":"%3Cinit%3E(org.shakespeareframework.selenium.WebDriverSupplier)"},{"p":"org.shakespeareframework.selenium","c":"BrowseTheWeb","l":"BrowseTheWeb(WebDriverSupplier, String)","u":"%3Cinit%3E(org.shakespeareframework.selenium.WebDriverSupplier,java.lang.String)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"CHROME"},{"p":"org.shakespeareframework.selenium","c":"BrowseTheWeb","l":"close()"},{"p":"org.shakespeareframework.selenium","c":"WebDriverManagerWebDriverSupplier","l":"close()"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"EDGE"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"failure(Actor, Question, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"failure(Actor, Question, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"failure(Actor, Question, A)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"failure(Actor, Question, A)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"failure(Actor, Task, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Task,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"failure(Actor, Task, Exception)","u":"failure(org.shakespeareframework.Actor,org.shakespeareframework.Task,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"FIREFOX"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"forName(String)","u":"forName(java.lang.String)"},{"p":"org.shakespeareframework.selenium","c":"WebDriverManagerWebDriverSupplier","l":"get()"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"getBaseCapabilities()"},{"p":"org.shakespeareframework.selenium","c":"WebDriverSupplier","l":"getBrowserType()"},{"p":"org.shakespeareframework.selenium","c":"WebDriverSupplier","l":"getCapabilities()"},{"p":"org.shakespeareframework.selenium","c":"BrowseTheWeb","l":"getWebDriver()"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"getWebDriverClass()"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"HtmlSnapshotReporter(Path)","u":"%3Cinit%3E(java.nio.file.Path)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"HtmlSnapshotReporter(Path, boolean)","u":"%3Cinit%3E(java.nio.file.Path,boolean)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"IEXPLORER"},{"p":"org.shakespeareframework.selenium","c":"LocalWebDriverSupplier","l":"LocalWebDriverSupplier(BrowserType)","u":"%3Cinit%3E(org.shakespeareframework.selenium.BrowserType)"},{"p":"org.shakespeareframework.selenium","c":"LocalWebDriverSupplier","l":"LocalWebDriverSupplier(BrowserType, Capabilities)","u":"%3Cinit%3E(org.shakespeareframework.selenium.BrowserType,org.openqa.selenium.Capabilities)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"retry(Actor, RetryableQuestion, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"retry(Actor, RetryableQuestion, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"retry(Actor, RetryableQuestion, A)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,A)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"retry(Actor, RetryableQuestion, A)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableQuestion,A)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"retry(Actor, RetryableTask, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableTask,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"retry(Actor, RetryableTask, Exception)","u":"retry(org.shakespeareframework.Actor,org.shakespeareframework.RetryableTask,java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"SAFARI"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"ScreenshotReporter(Path)","u":"%3Cinit%3E(java.nio.file.Path)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"ScreenshotReporter(Path, boolean)","u":"%3Cinit%3E(java.nio.file.Path,boolean)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"success(Actor, Question, A)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"success(Actor, Question, A)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Question,A)"},{"p":"org.shakespeareframework.selenium","c":"HtmlSnapshotReporter","l":"success(Actor, Task)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework.selenium","c":"ScreenshotReporter","l":"success(Actor, Task)","u":"success(org.shakespeareframework.Actor,org.shakespeareframework.Task)"},{"p":"org.shakespeareframework.selenium","c":"BrowseTheWeb","l":"toString()"},{"p":"org.shakespeareframework.selenium","c":"WebDriverSupplier","l":"toString()"},{"p":"org.shakespeareframework.selenium","c":"UnsupportedBrowserTypeException","l":"UnsupportedBrowserTypeException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.shakespeareframework.selenium","c":"BrowserType","l":"values()"},{"p":"org.shakespeareframework.selenium","c":"WebDriverManagerWebDriverSupplier","l":"WebDriverManagerWebDriverSupplier(WebDriverManager, BrowserType)","u":"%3Cinit%3E(io.github.bonigarcia.wdm.WebDriverManager,org.shakespeareframework.selenium.BrowserType)"},{"p":"org.shakespeareframework.selenium","c":"WebDriverManagerWebDriverSupplier","l":"WebDriverManagerWebDriverSupplier(WebDriverManager, BrowserType, Capabilities)","u":"%3Cinit%3E(io.github.bonigarcia.wdm.WebDriverManager,org.shakespeareframework.selenium.BrowserType,org.openqa.selenium.Capabilities)"},{"p":"org.shakespeareframework.selenium","c":"WebDriverSetupFailedException","l":"WebDriverSetupFailedException(Exception)","u":"%3Cinit%3E(java.lang.Exception)"},{"p":"org.shakespeareframework.selenium","c":"WebDriverSupplier","l":"WebDriverSupplier(BrowserType, Capabilities)","u":"%3Cinit%3E(org.shakespeareframework.selenium.BrowserType,org.openqa.selenium.Capabilities)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/module-search-index.js b/docs/v0.8.1/javadoc/selenium/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowseTheWeb.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowseTheWeb.html new file mode 100644 index 00000000..cb2f0f6d --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowseTheWeb.html @@ -0,0 +1,226 @@ + + + + +BrowseTheWeb (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class BrowseTheWeb

      +
      +
      java.lang.Object +
      org.shakespeareframework.selenium.BrowseTheWeb
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      AutoCloseable, org.shakespeareframework.Ability
      +
      +
      +
      @NullMarked +public final class BrowseTheWeb +extends Object +implements org.shakespeareframework.Ability, AutoCloseable
      +
      Ability to browse the web using a Selenium WebDriver.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          BrowseTheWeb

          +
          public BrowseTheWeb(WebDriverSupplier webDriverSupplier, + String baseUrl)
          +
          +
          Parameters:
          +
          webDriverSupplier - the WebDriverSupplier used to setup the WebDriver
          +
          baseUrl - a URL to be opened automatically
          +
          +
          +
        • +
        • +
          +

          BrowseTheWeb

          +
          public BrowseTheWeb(WebDriverSupplier webDriverSupplier)
          +
          +
          Parameters:
          +
          webDriverSupplier - the WebDriverSupplier used to setup the WebDriver
          +
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getWebDriver

          +
          public org.openqa.selenium.WebDriver getWebDriver()
          +
          Gets the WebDriver from the webDriverSupplier and returns it. + +

          If a baseUrl is given, it will be opened automatically.

          +
          +
          Returns:
          +
          a WebDriver instance.
          +
          See Also:
          +
          + +
          +
          +
          +
        • +
        • +
          +

          close

          +
          public void close() + throws Exception
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          Throws:
          +
          Exception
          +
          +
          +
        • +
        • +
          +

          toString

          +
          public String toString()
          +
          +
          Overrides:
          +
          toString in class Object
          +
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowserType.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowserType.html new file mode 100644 index 00000000..c6981978 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/BrowserType.html @@ -0,0 +1,308 @@ + + + + +BrowserType (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Enum Class BrowserType

      +
      +
      java.lang.Object +
      java.lang.Enum<BrowserType> +
      org.shakespeareframework.selenium.BrowserType
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<BrowserType>, Constable
      +
      +
      +
      @NullMarked +public enum BrowserType +extends Enum<BrowserType>
      +
      Enum of all browser types which are supported by WebDriverSupplier.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Enum Constant Details

        +
          +
        • +
          +

          CHROME

          +
          public static final BrowserType CHROME
          +
          Google Chrome
          +
          +
        • +
        • +
          +

          FIREFOX

          +
          public static final BrowserType FIREFOX
          +
          Mozilla Firefox
          +
          +
        • +
        • +
          +

          EDGE

          +
          public static final BrowserType EDGE
          +
          Microsoft Edge
          +
          +
        • +
        • +
          +

          IEXPLORER

          +
          public static final BrowserType IEXPLORER
          +
          Microsoft Internet Explorer
          +
          +
        • +
        • +
          +

          SAFARI

          +
          public static final BrowserType SAFARI
          +
          Apple Safari
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          values

          +
          public static BrowserType[] values()
          +
          Returns an array containing the constants of this enum class, in +the order they are declared.
          +
          +
          Returns:
          +
          an array containing the constants of this enum class, in the order they are declared
          +
          +
          +
        • +
        • +
          +

          valueOf

          +
          public static BrowserType valueOf(String name)
          +
          Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum class has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          +
        • +
        • +
          +

          forName

          +
          public static BrowserType forName(String string)
          +
          Looks up the named BrowserType, ignoring case.
          +
          +
          Parameters:
          +
          string - the desired browser type as String
          +
          Returns:
          +
          the desired BrowserType if known
          +
          Throws:
          +
          IllegalArgumentException - if the given string does not equal any Enum.name()
          +
          +
          +
        • +
        • +
          +

          getWebDriverClass

          +
          public Class<? extends org.openqa.selenium.WebDriver> getWebDriverClass()
          +
          Returns the WebDriver Class required to automate the BrowserType.
          +
          +
          Returns:
          +
          the WebDriver Class required to automate the BrowserType
          +
          +
          +
        • +
        • +
          +

          getBaseCapabilities

          +
          public org.openqa.selenium.Capabilities getBaseCapabilities()
          +
          Returns the base Capabilities of the BrowserType.
          +
          +
          Returns:
          +
          the base Capabilities of the BrowserType
          +
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/HtmlSnapshotReporter.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/HtmlSnapshotReporter.html new file mode 100644 index 00000000..e3b4e3f0 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/HtmlSnapshotReporter.html @@ -0,0 +1,298 @@ + + + + +HtmlSnapshotReporter (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class HtmlSnapshotReporter

      +
      +
      java.lang.Object +
      org.shakespeareframework.reporting.FileReporter +
      org.shakespeareframework.selenium.HtmlSnapshotReporter
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      org.shakespeareframework.reporting.QuestionReporter, org.shakespeareframework.reporting.Reporter, org.shakespeareframework.reporting.TaskReporter
      +
      +
      +
      @NullMarked +public class HtmlSnapshotReporter +extends org.shakespeareframework.reporting.FileReporter
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() to take an HTML snapshot + of the currently displayed site. By default, only retries and failures are reported. If reportSuccess is set true, successes are reported as well.
      +
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.shakespeareframework.reporting.FileReporter

        +org.shakespeareframework.reporting.FileReporter.ReportType
        +
        +
      • + +
      • +
        +

        Constructor Summary

        +
        Constructors
        +
        +
        Constructor
        +
        Description
        + +
        +
        Sets reportSuccess to false.
        +
        +
        HtmlSnapshotReporter(Path reportsPath, + boolean reportSuccess)
        +
         
        +
        +
        +
      • + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<?> question, + Exception cause)
        +
         
        +
        <A> void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
        +
         
        +
        void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task, + Exception cause)
        +
         
        +
        void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<?> question, + Exception cause)
        +
         
        +
        <A> void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<A> question, + A answer)
        +
         
        +
        void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableTask task, + Exception cause)
        +
         
        +
        <A> void
        +
        success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
        +
         
        +
        void
        +
        success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task)
        +
         
        +
        +
        +
        +
        +

        Methods inherited from class org.shakespeareframework.reporting.FileReporter

        +writeReport
        +
        +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface org.shakespeareframework.reporting.QuestionReporter

        +start
        +
        +

        Methods inherited from interface org.shakespeareframework.reporting.TaskReporter

        +start
        +
        +
      • +
      +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          HtmlSnapshotReporter

          +
          public HtmlSnapshotReporter(Path reportsPath, + boolean reportSuccess)
          +
          +
          Parameters:
          +
          reportsPath - the Path of the reports directory
          +
          reportSuccess - if true, this will report successes as well
          +
          +
          +
        • +
        • +
          +

          HtmlSnapshotReporter

          +
          public HtmlSnapshotReporter(Path reportsPath)
          +
          Sets reportSuccess to false.
          +
          +
          Parameters:
          +
          reportsPath - the Path of the reports directory
          +
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          retry

          +
          public void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableTask task, + Exception cause)
          +
          +
        • +
        • +
          +

          success

          +
          public void success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task)
          +
          +
        • +
        • +
          +

          failure

          +
          public void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task, + Exception cause)
          +
          +
        • +
        • +
          +

          retry

          +
          public void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<?> question, + Exception cause)
          +
          +
        • +
        • +
          +

          retry

          +
          public <A> void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<A> question, + A answer)
          +
          +
        • +
        • +
          +

          success

          +
          public <A> void success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
          +
          +
        • +
        • +
          +

          failure

          +
          public void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<?> question, + Exception cause)
          +
          +
        • +
        • +
          +

          failure

          +
          public <A> void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/LocalWebDriverSupplier.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/LocalWebDriverSupplier.html new file mode 100644 index 00000000..5ca24499 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/LocalWebDriverSupplier.html @@ -0,0 +1,160 @@ + + + + +LocalWebDriverSupplier (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class LocalWebDriverSupplier

      +
      + +
      +
      +
      All Implemented Interfaces:
      +
      AutoCloseable, Supplier<org.openqa.selenium.WebDriver>
      +
      +
      +
      @NullMarked +public class LocalWebDriverSupplier +extends WebDriverManagerWebDriverSupplier
      +
      A WebDriverSupplier for locally installed browser instances. Uses WebDriverManager to set up the local binary and create the WebDriver.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          LocalWebDriverSupplier

          +
          public LocalWebDriverSupplier(BrowserType browserType, + org.openqa.selenium.Capabilities additionalCapabilities)
          +
          +
          Parameters:
          +
          browserType - the BrowserType to be setup
          +
          additionalCapabilities - additional Capabilities for the WebDriver
          +
          +
          +
        • +
        • +
          +

          LocalWebDriverSupplier

          +
          public LocalWebDriverSupplier(BrowserType browserType)
          +
          +
          Parameters:
          +
          browserType - the BrowserType to be setup
          +
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/ScreenshotReporter.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/ScreenshotReporter.html new file mode 100644 index 00000000..872ce1d6 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/ScreenshotReporter.html @@ -0,0 +1,299 @@ + + + + +ScreenshotReporter (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class ScreenshotReporter

      +
      +
      java.lang.Object +
      org.shakespeareframework.reporting.FileReporter +
      org.shakespeareframework.selenium.ScreenshotReporter
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      org.shakespeareframework.reporting.QuestionReporter, org.shakespeareframework.reporting.Reporter, org.shakespeareframework.reporting.TaskReporter
      +
      +
      +
      @NullMarked +public class ScreenshotReporter +extends org.shakespeareframework.reporting.FileReporter
      +
      Reporter using the Actor's BrowseTheWeb.getWebDriver() as TakesScreenshot + to take a screenshot of the currently displayed site. By default, only retries and failures are + reported. If reportSuccess is set true, successes are reported as well.
      +
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.shakespeareframework.reporting.FileReporter

        +org.shakespeareframework.reporting.FileReporter.ReportType
        +
        +
      • + +
      • +
        +

        Constructor Summary

        +
        Constructors
        +
        +
        Constructor
        +
        Description
        +
        ScreenshotReporter(Path reportsPath)
        +
        +
        Sets reportSuccess to false.
        +
        +
        ScreenshotReporter(Path reportsPath, + boolean reportSuccess)
        +
         
        +
        +
        +
      • + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<?> question, + Exception cause)
        +
         
        +
        <A> void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
        +
         
        +
        void
        +
        failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task, + Exception cause)
        +
         
        +
        void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<?> question, + Exception cause)
        +
         
        +
        <A> void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<A> question, + A answer)
        +
         
        +
        void
        +
        retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableTask task, + Exception cause)
        +
         
        +
        <A> void
        +
        success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
        +
         
        +
        void
        +
        success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task)
        +
         
        +
        +
        +
        +
        +

        Methods inherited from class org.shakespeareframework.reporting.FileReporter

        +writeReport
        +
        +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface org.shakespeareframework.reporting.QuestionReporter

        +start
        +
        +

        Methods inherited from interface org.shakespeareframework.reporting.TaskReporter

        +start
        +
        +
      • +
      +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          ScreenshotReporter

          +
          public ScreenshotReporter(Path reportsPath, + boolean reportSuccess)
          +
          +
          Parameters:
          +
          reportsPath - the Path of the reports directory
          +
          reportSuccess - if true, this will report successes as well
          +
          +
          +
        • +
        • +
          +

          ScreenshotReporter

          +
          public ScreenshotReporter(Path reportsPath)
          +
          Sets reportSuccess to false.
          +
          +
          Parameters:
          +
          reportsPath - the Path of the reports directory
          +
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          retry

          +
          public void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableTask task, + Exception cause)
          +
          +
        • +
        • +
          +

          success

          +
          public void success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task)
          +
          +
        • +
        • +
          +

          failure

          +
          public void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Task task, + Exception cause)
          +
          +
        • +
        • +
          +

          retry

          +
          public void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<?> question, + Exception cause)
          +
          +
        • +
        • +
          +

          retry

          +
          public <A> void retry(org.shakespeareframework.Actor actor, + org.shakespeareframework.RetryableQuestion<A> question, + A answer)
          +
          +
        • +
        • +
          +

          success

          +
          public <A> void success(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
          +
          +
        • +
        • +
          +

          failure

          +
          public void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<?> question, + Exception cause)
          +
          +
        • +
        • +
          +

          failure

          +
          public <A> void failure(org.shakespeareframework.Actor actor, + org.shakespeareframework.Question<A> question, + A answer)
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/UnsupportedBrowserTypeException.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/UnsupportedBrowserTypeException.html new file mode 100644 index 00000000..3c1f3312 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/UnsupportedBrowserTypeException.html @@ -0,0 +1,151 @@ + + + + +UnsupportedBrowserTypeException (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class UnsupportedBrowserTypeException

      +
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      org.shakespeareframework.selenium.UnsupportedBrowserTypeException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      public class UnsupportedBrowserTypeException +extends RuntimeException
      +
      RuntimeException to be thrown when the given string did not match any BrowserType.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          UnsupportedBrowserTypeException

          +
          public UnsupportedBrowserTypeException(String string)
          +
          +
          Parameters:
          +
          string - the string not matching any BrowserType
          +
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverManagerWebDriverSupplier.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverManagerWebDriverSupplier.html new file mode 100644 index 00000000..ce7c6495 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverManagerWebDriverSupplier.html @@ -0,0 +1,205 @@ + + + + +WebDriverManagerWebDriverSupplier (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class WebDriverManagerWebDriverSupplier

      +
      +
      java.lang.Object +
      org.shakespeareframework.selenium.WebDriverSupplier +
      org.shakespeareframework.selenium.WebDriverManagerWebDriverSupplier
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      AutoCloseable, Supplier<org.openqa.selenium.WebDriver>
      +
      +
      +
      Direct Known Subclasses:
      +
      LocalWebDriverSupplier
      +
      +
      +
      @NullMarked +public class WebDriverManagerWebDriverSupplier +extends WebDriverSupplier
      +
      A WebDriverSupplier based on WebDriverManager.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          WebDriverManagerWebDriverSupplier

          +
          public WebDriverManagerWebDriverSupplier(io.github.bonigarcia.wdm.WebDriverManager webDriverManager, + BrowserType browserType, + @Nullable org.openqa.selenium.Capabilities additionalCapabilities)
          +
          +
          Parameters:
          +
          webDriverManager - the WebDriverManager that will be used to create the WebDriver
          +
          browserType - the BrowserType to be setup
          +
          additionalCapabilities - additional Capabilities for the WebDriver
          +
          +
          +
        • +
        • +
          +

          WebDriverManagerWebDriverSupplier

          +
          public WebDriverManagerWebDriverSupplier(io.github.bonigarcia.wdm.WebDriverManager webDriverManager, + BrowserType browserType)
          +
          +
          Parameters:
          +
          webDriverManager - the WebDriverManager that will be used to create the WebDriver
          +
          browserType - the BrowserType to be setup
          +
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          get

          +
          public org.openqa.selenium.WebDriver get()
          +
          +
        • +
        • +
          +

          close

          +
          public void close()
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSetupFailedException.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSetupFailedException.html new file mode 100644 index 00000000..e4e5545a --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSetupFailedException.html @@ -0,0 +1,151 @@ + + + + +WebDriverSetupFailedException (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class WebDriverSetupFailedException

      +
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      org.shakespeareframework.selenium.WebDriverSetupFailedException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      public class WebDriverSetupFailedException +extends RuntimeException
      +
      RuntimeException to be thrown when a WebDriverSupplier failed to setup the WebDriver.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          WebDriverSetupFailedException

          +
          public WebDriverSetupFailedException(Exception cause)
          +
          +
          Parameters:
          +
          cause - the causing Exception
          +
          +
          +
        • +
        +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSupplier.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSupplier.html new file mode 100644 index 00000000..c8cce612 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/WebDriverSupplier.html @@ -0,0 +1,221 @@ + + + + +WebDriverSupplier (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      + +
      + +

      Class WebDriverSupplier

      +
      +
      java.lang.Object +
      org.shakespeareframework.selenium.WebDriverSupplier
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      AutoCloseable, Supplier<org.openqa.selenium.WebDriver>
      +
      +
      +
      Direct Known Subclasses:
      +
      WebDriverManagerWebDriverSupplier
      +
      +
      +
      @NullMarked +public abstract class WebDriverSupplier +extends Object +implements Supplier<org.openqa.selenium.WebDriver>, AutoCloseable
      +
      A Supplier for WebDriver, which also takes care of quitting the WebDriver.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          WebDriverSupplier

          +
          protected WebDriverSupplier(BrowserType browserType, + @Nullable org.openqa.selenium.Capabilities additionalCapabilities)
          +
          Creates a WebDriverSupplier for the given BrowserType with additional Capabilities that will be merged with the BrowserType's baseCapabilities.
          +
          +
          Parameters:
          +
          browserType - the BrowserType to be setup
          +
          additionalCapabilities - additional Capabilities for the WebDriver
          +
          +
          +
        • +
        +
        +
      • + +
      • +
        +

        Method Details

        + +
        +
      • +
      +
      + +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-summary.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-summary.html new file mode 100644 index 00000000..07181952 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-summary.html @@ -0,0 +1,156 @@ + + + + +org.shakespeareframework.selenium (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package org.shakespeareframework.selenium

      +
      +
      +
      package org.shakespeareframework.selenium
      +
      +
      The central class of the selenium package is the BrowseTheWeb Ability, which requires a WebDriverSupplier to be instantiated. + +

      The following suppliers are available too: + +

      + +

      Additionally, the package contains some Reporters: + +

      + +

      Both are FileReporters and store the report files + according to the implementation there.

      +
      +
      See Also:
      +
      + +
      +
      +
      +
      + +
      +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-tree.html b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-tree.html new file mode 100644 index 00000000..209c63e6 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/org/shakespeareframework/selenium/package-tree.html @@ -0,0 +1,108 @@ + + + + +org.shakespeareframework.selenium Class Hierarchy (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package org.shakespeareframework.selenium

      +
      +
      +

      Class Hierarchy

      + +
      +
      +

      Enum Class Hierarchy

      + +
      +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/overview-tree.html b/docs/v0.8.1/javadoc/selenium/overview-tree.html new file mode 100644 index 00000000..b795c8d8 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/overview-tree.html @@ -0,0 +1,112 @@ + + + + +Class Hierarchy (selenium 0.8.1 API) + + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For All Packages

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      + +
      +
      +

      Enum Class Hierarchy

      + +
      +
      +
      +
      + + diff --git a/docs/v0.8.1/javadoc/selenium/package-search-index.js b/docs/v0.8.1/javadoc/selenium/package-search-index.js new file mode 100644 index 00000000..6f719f18 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.shakespeareframework.selenium"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/resources/glass.png b/docs/v0.8.1/javadoc/selenium/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/docs/v0.8.1/javadoc/selenium/resources/glass.png differ diff --git a/docs/v0.8.1/javadoc/selenium/resources/x.png b/docs/v0.8.1/javadoc/selenium/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/docs/v0.8.1/javadoc/selenium/resources/x.png differ diff --git a/docs/v0.8.1/javadoc/selenium/script-dir/jquery-3.6.1.min.js b/docs/v0.8.1/javadoc/selenium/script-dir/jquery-3.6.1.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
      "],col:[2,"","
      "],tr:[2,"","
      "],td:[3,"","
      "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
      ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
      "),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
        ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
        ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
        ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
        ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/script.js b/docs/v0.8.1/javadoc/selenium/script.js new file mode 100644 index 00000000..73cd8faa --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/script.js @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor); + elem.classList.add(isEvenRow ? evenRowColor : oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} + +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + contentDiv.addEventListener("scroll", function(e) { + var timeoutID; + if (!timeoutID) { + timeoutID = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + timeoutID = null; + }, 100); + } + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/docs/v0.8.1/javadoc/selenium/search.js b/docs/v0.8.1/javadoc/selenium/search.js new file mode 100644 index 00000000..db3b2f4a --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/search.js @@ -0,0 +1,354 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Classes and Interfaces"; +var catMembers = "Members"; +var catSearchTags = "Search Tags"; +var highlight = "$&"; +var searchPattern = ""; +var fallbackPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MIN_RESULTS = 3; +var MAX_RESULTS = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher, fallbackMatcher) { + var escapedItem = escapeHtml(item); + var highlighted = escapedItem.replace(matcher, highlight); + if (highlighted === escapedItem) { + highlighted = escapedItem.replace(fallbackMatcher, highlight) + } + return highlighted; +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + } + return urlPrefix; +} +function createSearchPattern(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + var search = $("#search-input"); + var reset = $("#reset-button"); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + search.val(watermark).addClass('watermark'); + search.blur(function() { + if ($(this).val().length === 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + search.on('click keydown paste', function() { + if ($(this).val() === watermark) { + $(this).val('').removeClass('watermark'); + } + }); + reset.click(function() { + search.val('').focus(); + }); + search.focus()[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("
      • " + item.category + "
      • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + var fallbackMatcher = new RegExp(fallbackPattern, "gi") + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else { + label = item.l; + } + var li = $("
      • ").appendTo(ul); + var div = $("
        ").appendTo(li); + if (item.category === catSearchTags && item.h) { + if (item.d) { + div.html(label + " (" + item.h + ")
        " + + item.d + "
        "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + var endOfName = leftParen > -1 ? leftParen : input.length; + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + searchPattern = createSearchPattern(request.term); + fallbackPattern = createSearchPattern(request.term.toLowerCase()); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var fallbackMatcher = new RegExp(fallbackPattern, "i"); + + function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) { + if (indexArray) { + var newResults = []; + $.each(indexArray, function (i, item) { + item.category = category; + var ranking = rankMatch(matcher.exec(nameFunc(item)), category); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ranking: ranking, item: item}); + } + return newResults.length <= MAX_RESULTS; + }); + return newResults.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }).map(function(e) { + return e.item; + }); + } + return []; + } + function searchIndex(indexArray, category, nameFunc) { + var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc); + result = result.concat(primaryResults); + if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) { + var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc); + result = result.concat(secondaryResults.filter(function (item) { + return primaryResults.indexOf(item) === -1; + })); + } + } + + searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; }); + searchIndex(packageSearchIndex, catPackages, function(item) { + return (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) : item.l; + }); + searchIndex(typeSearchIndex, catTypes, function(item) { + return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l; + }); + searchIndex(memberSearchIndex, catMembers, function(item) { + return request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l : item.l; + }); + searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; }); + + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search-input").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search-input").focus(); + } + } + }); +}); diff --git a/docs/v0.8.1/javadoc/selenium/serialized-form.html b/docs/v0.8.1/javadoc/selenium/serialized-form.html new file mode 100644 index 00000000..d2e7e65c --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/serialized-form.html @@ -0,0 +1,76 @@ + + + + +Serialized Form (selenium 0.8.1 API) + + + + + + + + + + + + + + +
        + +
        +
        +
        +

        Serialized Form

        +
        + +
        +
        +
        + + diff --git a/docs/v0.8.1/javadoc/selenium/stylesheet.css b/docs/v0.8.1/javadoc/selenium/stylesheet.css new file mode 100644 index 00000000..4a576bd2 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/stylesheet.css @@ -0,0 +1,869 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; +} +h4 { + font-size:15px; +} +h5 { + font-size:14px; +} +h6 { + font-size:13px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +.summary-table dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0; + overflow:hidden; +} +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:11px; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + min-height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.sub-nav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.sub-nav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { + list-style:none; + float:left; + padding-top:10px; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.nav-bar-cell1-rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header and footer. + */ +.title { + color:#2c4557; + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.see-list, ul.see-list-long { + padding-left: 0; + list-style: none; +} +ul.see-list li { + display: inline; +} +ul.see-list li:not(:last-child):after, +ul.see-list-long li:not(:last-child):after { + content: ", "; + white-space: pre-wrap; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0; + padding-top:10px; + padding-left:1px; + margin:0; + white-space:pre; +} +.caption a:link, .caption a:visited { + color:#1f389c; +} +.caption a:hover, +.caption a:active { + color:#FFFFFF; +} +.caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +@media screen and (max-width: 800px) { + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-summary .col-last { + grid-column-end: span 2; + } +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:#dee3e9; + font-weight: bold; +} +.col-first, .col-first { + font-size:13px; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:13px; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited, +.constant-values-container a:link, .constant-values-container a:visited, +.all-classes-container a:link, .all-classes-container a:visited, +.all-packages-container a:link, .all-packages-container a:visited { + font-weight:bold; +} +.table-sub-heading-color { + background-color:#EEEEFF; +} +.even-row-color, .even-row-color .table-header { + background-color:#FFFFFF; +} +.odd-row-color, .odd-row-color .table-header { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.deprecated-content { + margin:0; + padding:10px 0; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:0 10px 5px 0; + color:#474747; +} +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset-button { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +span.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak font sizes and paddings for small screens. + */ +@media screen and (max-width: 1050px) { + #search-input { + width: 300px; + } +} +@media screen and (max-width: 800px) { + #search-input { + width: 200px; + } + .top-nav, + .bottom-nav { + font-size: 11px; + padding-top: 6px; + } + .sub-nav { + font-size: 11px; + } + .about-language { + padding-right: 16px; + } + ul.nav-list li, + .sub-nav .nav-list-search { + padding: 6px; + } + ul.sub-nav-list li { + padding-top: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 500px) { + #search-input { + width: 150px; + } + .top-nav, + .bottom-nav { + font-size: 10px; + } + .sub-nav { + font-size: 10px; + } + .about-language { + font-size: 10px; + padding-right: 12px; + } +} diff --git a/docs/v0.8.1/javadoc/selenium/tag-search-index.js b/docs/v0.8.1/javadoc/selenium/tag-search-index.js new file mode 100644 index 00000000..f38b3cb3 --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/javadoc/selenium/type-search-index.js b/docs/v0.8.1/javadoc/selenium/type-search-index.js new file mode 100644 index 00000000..1d44911a --- /dev/null +++ b/docs/v0.8.1/javadoc/selenium/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.shakespeareframework.selenium","l":"BrowserType"},{"p":"org.shakespeareframework.selenium","l":"BrowseTheWeb"},{"p":"org.shakespeareframework.selenium","l":"HtmlSnapshotReporter"},{"p":"org.shakespeareframework.selenium","l":"LocalWebDriverSupplier"},{"p":"org.shakespeareframework.selenium","l":"ScreenshotReporter"},{"p":"org.shakespeareframework.selenium","l":"UnsupportedBrowserTypeException"},{"p":"org.shakespeareframework.selenium","l":"WebDriverManagerWebDriverSupplier"},{"p":"org.shakespeareframework.selenium","l":"WebDriverSetupFailedException"},{"p":"org.shakespeareframework.selenium","l":"WebDriverSupplier"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/v0.8.1/manual/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache b/docs/v0.8.1/manual/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache new file mode 100644 index 00000000..df33cab3 --- /dev/null +++ b/docs/v0.8.1/manual/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache @@ -0,0 +1 @@ +{"checksum":"7a3e81e6682727c1b0fc0823c5b40be1","options":{"scale":null,"tabs":null,"background":null,"antialias":null,"separation":null,"round_corners":null,"shadows":null,"debug":null,"fixed_slope":null,"transparent":null,"bullet_characters":null},"width":680,"height":280} \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache b/docs/v0.8.1/manual/chapters/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache new file mode 100644 index 00000000..df33cab3 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/.asciidoctor/diagram/diag-7a3e81e6682727c1b0fc0823c5b40be1.png.cache @@ -0,0 +1 @@ +{"checksum":"7a3e81e6682727c1b0fc0823c5b40be1","options":{"scale":null,"tabs":null,"background":null,"antialias":null,"separation":null,"round_corners":null,"shadows":null,"debug":null,"fixed_slope":null,"transparent":null,"bullet_characters":null},"width":680,"height":280} \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/00-introduction.html b/docs/v0.8.1/manual/chapters/00-introduction.html new file mode 100644 index 00000000..6c96746f --- /dev/null +++ b/docs/v0.8.1/manual/chapters/00-introduction.html @@ -0,0 +1,661 @@ + + + + + + + +Introduction + + + + + + + + +
        +
        +

        Shakespeare

        +
        +
        +

        Shakespeare is a Java implementation of Screenplay. +It was mainly created to explain the basic concepts of Screenplay and hence is kept rather simple in its core.

        +
        +
        +
        +
        +

        Screenplay

        +
        +
        +

        A framework helping to write tests like screenplays. +It is based on the ideas from Page Objects Refactored by Antony Marcano, Andy Palmer & John Ferguson Smart, with Jan Molak.

        +
        +
        +

        Screenplay does not replace any testing framework like JUnit, TestNG, Spock, RSpec, Jasmine etc. +In fact, it works with any of these. +Screenplay rather structures complex test code in a different way that makes it

        +
        +
        +
          +
        • +

          more readably,

          +
        • +
        • +

          more reusable, and

          +
        • +
        • +

          more maintainable.

          +
        • +
        +
        +
        +

        It does that mainly by taking a user-centric and object-oriented view on things.

        +
        +
        +

        In screenplay a user is represented by as an Actor. +Actors can have Abilities. +These enable them to do Tasks or answer Questions.

        +
        +
        +
        +Diagram +
        +
        Figure 1. Screenplay Core Concepts
        +
        +
        +

        In screenplay each of these concepts—​Actor, Ability, Task and Question—​are objects which abstract from the actual actions.

        +
        +
        +

        Actions can be calling an API, clicking a link, fetching an email, waiting for something to appear. +All these tiny noisy details are hidden within the Task or Question objects.

        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/01-getting-started.html b/docs/v0.8.1/manual/chapters/01-getting-started.html new file mode 100644 index 00000000..dc00db53 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/01-getting-started.html @@ -0,0 +1,708 @@ + + + + + + + +Getting Started + + + + + + + + +
        +
        +

        Requirements

        +
        +
        +

        In oder to use Shakespeare you need a JDK 11 or higher.

        +
        +
        +
        +
        +

        Dependencies

        +
        +
        +

        To use Shakespeare in your own project, you need to add it as a dependency to your project.

        +
        +
        +
        Gradle
        +
        +
        implementation 'org.shakespeareframework:core:0.8.1'
        +
        +
        +
        +
        Gradle.kts
        +
        +
        implementation("org.shakespeareframework:core:0.8.1")
        +
        +
        +
        +
        Maven
        +
        +
        <dependency>
        +  <groupId>org.shakespeareframework</groupId>
        +  <artifactId>core</artifactId>
        +  <version>0.8.1</version>
        +</dependency>
        +
        +
        +
        + + + + + +
        +
        Note
        +
        +The core module is a transient dependency of any other module. +Hence, you don’t need to keep it once you add another module (e.g. selenium or retrofit) +
        +
        +
        +

        Bill of Materials

        +
        +

        If you want to use more than one module in the same project, you can use Shakespeare’s bill of materials (BOM) and omit the explicit version for the other modules.

        +
        +
        +
        Gradle
        +
        +
        implementation platform('org.shakespeareframework:bom:0.8.1')
        +implementation 'org.shakespeareframework:selenium'
        +implementation 'org.shakespeareframework:retrofit'
        +
        +
        +
        +
        Gradle.kts
        +
        +
        implementation(platform("org.shakespeareframework:bom:0.8.1"))
        +implementation("org.shakespeareframework:selenium")
        +implementation("org.shakespeareframework:retrofit")
        +
        +
        +
        +
        Maven
        +
        +
        <project>
        +  <!--…-->
        +  <dependencyManagement>
        +    <dependencies>
        +      <dependency>
        +        <groupId>org.shakespeareframework</groupId>
        +        <artifactId>bom</artifactId>
        +        <version>0.8.1</version>
        +        <type>pom</type>
        +        <scope>import</scope>
        +      </dependency>
        +    </dependencies>
        +  </dependencyManagement>
        +  <!-- … -->
        +  <dependencies>
        +    <dependency>
        +      <groupId>org.shakespeareframework</groupId>
        +      <artifactId>selenium</artifactId>
        +    </dependency>
        +    <dependency>
        +      <groupId>org.shakespeareframework</groupId>
        +      <artifactId>retrofit</artifactId>
        +    </dependency>
        +  </dependencies>
        +  <!-- … -->
        +</project>
        +
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/02-actors-with-abilities.html b/docs/v0.8.1/manual/chapters/02-actors-with-abilities.html new file mode 100644 index 00000000..33d065cf --- /dev/null +++ b/docs/v0.8.1/manual/chapters/02-actors-with-abilities.html @@ -0,0 +1,710 @@ + + + + + + + +Actors with Abilities + + + + + + + + +
        +
        +

        Actors

        +
        +
        +

        The central object in a Screenplay and Shakespeare is the Actor. +Actors represent something or someone that interacts with the system under test.

        +
        +
        +

        There can be any number of Actors in a Screenplay (Test). +To make different Actors easily identifiable, they have a name. +The name can be explicitly given or will be randomly assigned.

        +
        +
        +
        Java
        +
        +
        var robin = new Actor("Robin");
        +
        +
        +
        +
        Kotlin
        +
        +
        val robin = Actor("Robin")
        +
        +
        +
        +
        Java
        +
        +
        var user = new Actor();
        +
        +
        +
        +
        Kotlin
        +
        +
        val user = Actor()
        +
        +
        +
        +
        +
        +

        Abilities

        +
        +
        +

        Actors may use Abilities to interact with the system under test.

        +
        +
        +

        Ability is a simple marker interface. +Implementations should provide methods providing an object which allows interaction with the system under test. +If that object is being generated on demand or simply wrapped by the Ability is up to the implementation.

        +
        +
        +
        Java
        +
        +
        class Log implements Ability {
        +
        +  private final Logger logger;
        +
        +  Log(String name) {
        +    this.logger = Logger.getLogger(name);
        +  }
        +
        +  public Logger getLogger() {
        +    return logger;
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class Log(val name: String, val logger: Logger = Logger.getLogger(name)) : Ability
        +
        +
        +
        +

        To allow Actors to use an Ability it needs to be given to them via the can(Ability) method.

        +
        +
        +
        Java
        +
        +
        var anna = new Actor("Anna").can(new Log("Anna"));
        +
        +
        +
        +
        Kotlin
        +
        +
        val anna = Actor("Anna").can(Log("Anna"))
        +
        +
        +
        +

        To get an Ability from an Actor, there’s the uses(Class<? extends Ability>) method.

        +
        +
        +
        Java
        +
        +
        var log = anna.uses(Log.class);
        +log.getLogger().info("Hello World");
        +
        +
        +
        +
        Kotlin
        +
        +
        val log = anna.uses(Log::class.java)
        +log.logger.info("Hello World")
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/03-doing-tasks.html b/docs/v0.8.1/manual/chapters/03-doing-tasks.html new file mode 100644 index 00000000..589142a1 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/03-doing-tasks.html @@ -0,0 +1,917 @@ + + + + + + + +Doing Tasks + + + + + + + + +
        +
        +

        Tasks

        +
        +
        +

        Tasks can be done by an Actor. +What the actor should do is defined in the performAs(Actor) method of the Task.

        +
        +
        +

        As the Actor is given as an argument, the Task implementation has access to the Actor’s Abilities via the uses(Class<? extends Ability>) method.

        +
        +
        +
        Java
        +
        +
        class SayHelloWorld implements Task {
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info("Hello World");
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        class SayHelloWorld() : Task {
        +  override fun performAs(actor: Actor) {
        +    val logger = actor.uses(Log::class.java).logger
        +    logger.info("Hello World")
        +  }
        +}
        +
        +
        +
        +
        Java
        +
        +
        tom.does(new SayHelloWorld());
        +
        +
        +
        +
        Kotlin
        +
        +
        tom.does(SayHelloWorld())
        +
        +
        +
        +
        +
        +

        Tasks with Parameters

        +
        +
        +

        Some tasks require data to be executed. +E.g. a SearchFor Task probably needs a query string, or an AddToCart Task might need a product identifier.

        +
        +
        +

        Such data can be added as properties of the Task.

        +
        +
        +
        Java
        +
        +
        class SayHello implements Task {
        +
        +  private final String to;
        +
        +  public SayHello(String to) {
        +    this.to = to;
        +  }
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info(String.format("Hello %s", to));
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class SayHello(val to: String) : Task {
        +  override fun performAs(actor: Actor) {
        +    val logger = actor.uses(Log::class.java).logger
        +    logger.info("Hello $to")
        +  }
        +}
        +
        +
        +
        +

        As Tasks should not change over time and should be reusable, it is also possible to declare them as Java Records—​given that you can use Java 17+ features.

        +
        +
        +

        Doing the Tasks is the same for Classes and Records.

        +
        +
        +
        Java
        +
        +
        record SayHelloAsRecord(String to) implements Task {
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info(String.format("Hello %s", to));
        +  }
        +}
        +
        +
        +
        +
        Java
        +
        +
        alex.does(new SayHello("Shakespeare"));
        +alex.does(new SayHelloAsRecord("Shakespeare"));
        +
        +
        +
        +
        Kotlin
        +
        +
        alex.does(SayHello("Shakespeare"))
        +
        +
        +
        +
        +
        +

        Lambdas as Tasks

        +
        +
        +

        As Tasks only have one abstract method, they can be declared using Java’s Lambda syntax.

        +
        +
        +
        Java
        +
        +
        mila.does(she -> she.uses(Log.class).getLogger().info("Hi"));
        +
        +
        +
        +
        Kotlin
        +
        +
        mila.does { she -> she.uses(Log::class.java).logger.info("Hi") }
        +
        +
        +
        + + + + + +
        +
        Note
        +
        +A Task should group complex interactions into a semantic unit of work. +So declaring them as Lambdas might be useful for short-lived experiments or debugging, but is not generally advisable. +
        +
        +
        +
        +
        +

        Abstraction Levels

        +
        +
        +

        Tasks are a powerful tool. +A task can be as simple as clicking on a link and as complex as a double-opt-in registration process. +Finding the right abstraction can be hard. +This chapter contains some examples how to find the right level of abstraction for Tasks.

        +
        +
        +

        Grouping Interactions

        +
        +

        The simplest kind of Tasks are those who group simple interactions with the system under test.

        +
        +
        +

        Let’s take a Task to log in to a website. +This might consist of the following interactions with the website:

        +
        +
        +
        Java
        +
        +
        class Login implements Task {
        +
        +  private final String username;
        +  private final String password;
        +
        +  Login(String username, String password) {
        +    this.username = username;
        +    this.password = password;
        +  }
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var webDriver = actor.uses(BrowseTheWeb.class).getWebDriver();
        +
        +    webDriver.get(mockWebServer.url("/").toString()); // (1)
        +
        +    webDriver
        +        .findElement(By.name("username")) // (2)
        +        .sendKeys(username); // (3)
        +    webDriver
        +        .findElement(By.name("password")) // (4)
        +        .sendKeys(password); // (5)
        +    webDriver
        +        .findElement(By.cssSelector(".login button")) // (6)
        +        .click(); // (7)
        +  }
        +
        +  @Override
        +  public String toString() {
        +    return String.format("login as %s", username);
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class Login(private val username: String, private val password: String) : Task {
        +
        +  override fun performAs(actor: Actor) {
        +    val webDriver = actor.uses(BrowseTheWeb::class.java).webDriver
        +
        +    webDriver.get(mockWebServer.url("/").toString()) // (1)
        +
        +    webDriver
        +      .findElement(By.name("username")) // (2)
        +      .sendKeys(username) // (3)
        +    webDriver
        +      .findElement(By.name("password")) // (4)
        +      .sendKeys(password) // (5)
        +    webDriver
        +      .findElement(By.cssSelector(".login button")) // (6)
        +      .click() // (7)
        +  }
        +
        +  override fun toString(): String {
        +    return "login as $username"
        +  }
        +}
        +
        +
        +
        +
          +
        1. +

          Navigate to the website,

          +
        2. +
        3. +

          find the "username" input field,

          +
        4. +
        5. +

          write "john" into it,

          +
        6. +
        7. +

          find the "password" input field,

          +
        8. +
        9. +

          write "demo" into it,

          +
        10. +
        11. +

          find the login button,

          +
        12. +
        13. +

          click on it.

          +
        14. +
        +
        +
        +

        As you can see all the interactions are wrapped in the Task object. +It has fields for the username and the password, so we can easily reuse the Task with other credentials.

        +
        +
        +
        +

        Grouping Tasks

        +
        +

        As the Actor is fully injected into the performAs method, it is also possible to do other tasks in a Task.

        +
        +
        +

        Let’s take a shop website as an example. +In order to check out, there are several complex steps needed:

        +
        +
        +
          +
        1. +

          Add any product to the shopping cart,

          +
        2. +
        3. +

          navigate to the checkout page,

          +
        4. +
        5. +

          enter a delivery address,

          +
        6. +
        7. +

          enter valid payment details,

          +
        8. +
        9. +

          confirm the checkout.

          +
        10. +
        +
        +
        +

        All these steps could be Tasks in their own right, but if we want to test that the user is able to cancel the order after check out, we might want to bundle the steps into something like a Checkout Task.

        +
        +
        + + + + + +
        +
        Warning
        +
        +It is generally a bad idea to mix simple interactions with sub-tasks, as it makes finding problems much harder! +
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/04-checking-questions.html b/docs/v0.8.1/manual/chapters/04-checking-questions.html new file mode 100644 index 00000000..23b88fe6 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/04-checking-questions.html @@ -0,0 +1,716 @@ + + + + + + + +Checking Questions + + + + + + + + +
        +
        +

        Questions

        +
        +
        +

        Questions are pretty similar to [Tasks], but may return an answer.

        +
        +
        +

        They can be checked (answered) by an Actor. +How the Actor finds the answer to a Question is defined in the answerAs(Actor) method of the Question.

        +
        +
        +

        Similar to the performAs(Actor) method of the Task, the Actor is given as an argument, so a Question can use all the Actor’s Abilities to find the answer.

        +
        +
        +
        Java
        +
        +
        class LoggedInState implements Question<Boolean> {
        +
        +  @Override
        +  public Boolean answerAs(Actor actor) {
        +    var webDriver = actor.uses(BrowseTheWeb.class).getWebDriver();
        +
        +    return !webDriver.findElements(By.linkText("Log Out")).isEmpty();
        +  }
        +
        +  @Override
        +  public String toString() {
        +    return "login state";
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        class LoggedInState : Question<Boolean> {
        +
        +  override fun answerAs(actor: Actor): Boolean {
        +    val webDriver = actor.uses(BrowseTheWeb::class.java).webDriver
        +    return webDriver.findElements(By.linkText("Log Out")).isNotEmpty()
        +  }
        +
        +  override fun toString(): String {
        +    return "login state"
        +  }
        +}
        +
        +
        +
        +

        While it is possible to put complex interactions in Questions it is generally advisable to keep them simple and independent.

        +
        +
        +

        Good Questions

        +
        +

        Undoubtedly good questions do not change the state of the system under test in any way

        +
        +
        +
          +
        • +

          Checking a web element is present,

          +
        • +
        • +

          performing a GET call on an HTTP API and return its body,

          +
        • +
        • +

          fetching email and retuning its content.

          +
        • +
        +
        +
        +
        +

        Ugly Questions

        +
        +

        Doubtfully ugly questions don’t change the persisted state of the system under test, but change the local state. +For example the current displayed view. +Using such questions requires to check the state in following Tasks or Questions.

        +
        +
        +
          +
        • +

          Navigate to the user’s profile page to check for data that is only visible there,

          +
        • +
        • +

          checking available products by switching to the search results page.

          +
        • +
        +
        +
        +

        Especially in web applications this type of Questions are often unavoidable, but should be kept to a minimum.

        +
        +
        +
        +

        Bad Questions

        +
        +

        Changing the persistent state of the system under test should genrally be avoided and be left to Tasks.

        +
        +
        +
          +
        • +

          Sending data to a backend API,

          +
        • +
        • +

          login to a web application,

          +
        • +
        • +

          deleting email.

          +
        • +
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/05-retryables.html b/docs/v0.8.1/manual/chapters/05-retryables.html new file mode 100644 index 00000000..96c57936 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/05-retryables.html @@ -0,0 +1,680 @@ + + + + + + + +Retryables + + + + + + + + +
        +
        +
        +
        +

        Some things take time. +E.g. after creating an account, it might take some time for a confirmation email to arrive.

        +
        +
        +

        Shakespeare provides a generic way to wait for things to succeed: Retryables.

        +
        +
        +

        They can be used just like regular Tasks and Questions, but they additionally have a defined timeout after which an Actor will give up and an interval in which an Actor will retry. +The default timeout is 2 seconds, the default interval is the 10th of the timeout.

        +
        +
        + + + + + +
        +
        Note
        +
        +Shakespeare’s Retryables are meant for things that a human user would need to retry as well. +To wait for UI elements to show up, there are better usually more efficient ways available (e.g. in Selenium, Cypress etc.). +
        +
        +
        +
        +
        +

        Retryable Tasks

        +
        +
        +

        A RetryableTask also has a set of acknowledged exceptions. +By default, an Actor will ignore all Exceptions thrown in retries, but will immediately fail if it is an instance of an acknowledged Exception.

        +
        +
        +

        E.g. you might expect a NotFoundException but not a AuthorizationFailedException. +So you can just add the latter to the acknowledgedExceptions.

        +
        +
        +
        +
        +

        Retryable Questions

        +
        +
        +

        A RetryableQuestion has a set of ignored Exceptions and an acceptable method. +While any Exception thrown that is not in the set of ignored exceptions will break the retrying loop, the acceptable method will be called for each yielded answer. +Only if the acceptable method returns true, the retrying will stop and return the (accepted) answer.

        +
        +
        +

        There is a default implementation of acceptable, which will a number of possible answers:

        +
        +
        +
          +
        1. +

          Optionals that are present,

          +
        2. +
        3. +

          non-empty Collections, Maps or Arrays,

          +
        4. +
        5. +

          any Boolean answer, and

          +
        6. +
        7. +

          anything that not null.

          +
        8. +
        +
        +
        +

        Checked in that order.

        +
        +
        +

        This default implementation might suit your needs already, but you can always override it with your own logic.

        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/06-learning-remembering-facts.html b/docs/v0.8.1/manual/chapters/06-learning-remembering-facts.html new file mode 100644 index 00000000..68430792 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/06-learning-remembering-facts.html @@ -0,0 +1,831 @@ + + + + + + + +Learning & Remembering Facts + + + + + + + + +
        +
        +
        +
        +

        Facts are a way to add data to the Actor. +After a Fact was learned, it can always be remembered by its class and be used to do Tasks or answer Questions.

        +
        +
        +
        Java
        +
        +
        kate.learns(new PhoneNumber("+49 0180 4 100 100"));
        +
        +PhoneNumber katesPhoneNumber = kate.remembers(PhoneNumber.class);
        +
        +
        +
        +
        Kotlin
        +
        +
        kate.learns(PhoneNumber("+49 0180 4 100 100"))
        +
        +val katesPhoneNumber = kate.remembers(PhoneNumber::class.java)
        +
        +
        +
        +

        Fact classes only need to implement the (empty) Fact marker interface. +Apart from that they can be basically anything but should be immutable value objects or records.

        +
        +
        +
        Java
        +
        +
        record PhoneNumber(String number) implements Fact {}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class PhoneNumber(val number: String) : Fact
        +
        +
        +
        +
        +
        +

        Relearning Facts

        +
        +
        +

        Note that an Actor cannot remember multiple instances of a Fact. +When you call remember with two different instances of the same Fact class, the older one is being forgotten and replaced by the new one.

        +
        +
        +
        Java
        +
        +
        kate.learns(new PhoneNumber("+49 0180 4 100 100"));
        +
        +kate.learns(new PhoneNumber("+1 (303) 499-7111"));
        +
        +PhoneNumber katesNewPhoneNumber = kate.remembers(PhoneNumber.class);
        +assertThat(katesNewPhoneNumber).isEqualTo(new PhoneNumber("+1 (303) 499-7111"));
        +
        +
        +
        +
        Kotlin
        +
        +
        kate.learns(PhoneNumber("+49 0180 4 100 100"))
        +
        +kate.learns(PhoneNumber("+1 (303) 499-7111"))
        +
        +val katesNewPhoneNumber = kate.remembers(PhoneNumber::class.java)
        +assertThat(katesNewPhoneNumber).isEqualTo(PhoneNumber("+1 (303) 499-7111"))
        +
        +
        +
        +
        +
        +

        Poly Facts

        +
        +
        +

        One way to achieve something similar are Poly Facts: Simply Facts with multiple fields.

        +
        +
        +

        E.g. a PhoneNumbers Fact might contain a field for a work phone number and one for a home phone number:

        +
        +
        +
        Java
        +
        +
        record PhoneNumbers(String home, String work) implements Fact {}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class PhoneNumbers(val home: String, val work: String) : Fact
        +
        +
        +
        +
        Java
        +
        +
        robin.learns(new PhoneNumbers("+49 0180 4 100 100", "+1 (303) 499-7111"));
        +
        +var robinsPhoneNumbers = robin.remembers(PhoneNumbers.class);
        +var robinsHomePhoneNumber = robinsPhoneNumbers.home();
        +var robinsWorkPhoneNumber = robinsPhoneNumbers.work();
        +
        +
        +
        +
        Kotlin
        +
        +
        robin.learns(PhoneNumbers(home = "+49 0180 4 100 100", work = "+1 (303) 499-7111"))
        +
        +val robinsPhoneNumbers = robin.remembers(PhoneNumbers::class.java)
        +val robinsHomePhoneNumber = robinsPhoneNumbers.home
        +val robinsWorkPhoneNumber = robinsPhoneNumbers.work
        +
        +
        +
        +
        +
        +

        Facts with Defaults and Generators

        +
        +
        +

        One great advantage of Fact classes is the possibility of adding static fields and methods.

        +
        +
        +

        E.g. you can put that one valid test credit card number in a public static CreditCard DEFAULT in your CreditCard Fact class:

        +
        +
        +
        Java
        +
        +
        record CreditCard(String type, String number, YearMonth expiration) implements Fact {
        +  public static CreditCard DEFAULT_VISA =
        +      new CreditCard("visa", "4111111111111111", YearMonth.of(2026, 10));
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class CreditCard(val type: String, val number: String, val expiration: YearMonth) : Fact {
        +  companion object {
        +    val DEFAULT_VISA =
        +      CreditCard("visa", "4111111111111111", YearMonth.of(2026, 10))
        +  }
        +}
        +
        +
        +
        +

        Or you can add a method to generate valid unique random email addresses to your EmailAddress Fact class:

        +
        +
        +
        Java
        +
        +
        record EmailAddress(String address) implements Fact {
        +  public static EmailAddress random() {
        +    return new EmailAddress("%s@shakespeareframework.org".formatted(UUID.randomUUID()));
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class EmailAddress(val address: String) : Fact {
        +  companion object {
        +    fun random() = EmailAddress("${UUID.randomUUID()}@shakespeareframework.org")
        +  }
        +}
        +
        +
        +
        +
        +
        +

        Personalized Tasks/Questions

        +
        +
        +

        Facts can be used to provide an Actor with necessary information for certain Tasks and Questions instead of using [Tasks with Parameters].

        +
        +
        +

        By doing so, we can instruct an Actors to do something with their memory as context.

        +
        +
        +

        For example, to create an account we usually require a lot of personal information. +To human testers, I can say "go create an account", and they will use their own data to do that. +Using Facts we can achieve the same feel of a personal context.

        +
        +
        +

        In that case, an Actors learn their facts in the setup phase of a test.

        +
        +
        + + + + + +
        +
        Warning
        +
        +Using Facts in your Tasks and Questions can be a really nice experience. +You don’t need to keep your test data at hand in you test code, but can confine it in the test’s setup phase. +However, by doing so you might end up scrolling back and forth in order to understand a failing test. +So you really want to limit this to data that is really owned by an Actor. +
        +
        +
        +
        +
        +

        Learning by Doing

        +
        +
        +

        Another possible use case for Facts is to learn things while doing things. +E.g. after finishing a shop’s checkout process it might be useful to remember the displayed order number.

        +
        +
        +

        In that case the Facts are learned as a side effect of a Task or a Question.

        +
        +
        + + + + + +
        +
        Warning
        +
        +Don’t overdo this! +Side effects are not easy to keep track of. +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/07-reporting.html b/docs/v0.8.1/manual/chapters/07-reporting.html new file mode 100644 index 00000000..55ed60df --- /dev/null +++ b/docs/v0.8.1/manual/chapters/07-reporting.html @@ -0,0 +1,682 @@ + + + + + + + +Reporting + + + + + + + + +
        +
        +
        +
        +

        Actors can report actions and their outcome via Reporters that can be added using the link:{javadoc-url}/core/org/shakespeareframework/Actor.html#informs(org.shakespeareframework.reporting.Reporter…​))[informs(Reporter…​) method.

        +
        +
        +

        Actors call each of their Reporters in the declared order for the following events:

        +
        +
        +
          +
        • +

          When starting to do a Task or answer a Question,

          +
        • +
        • +

          when retrying a RetryableTask or RetryableQuestion,

          +
        • +
        • +

          when successfully finishing a Task or successfully answering a Question,

          +
        • +
        • +

          when failing to do a Task or answer a Question.

          +
        • +
        +
        +
        +
        +
        +

        Built-In Reporters

        +
        +
        +

        The Slf4jReporter

        +
        +

        Uses the Slf4j Logger to print each action of the Actor. +Successful actions will be logged as info, failure as warnings. +Note that actions are only logged after finishing.

        +
        +
        +

        Each action is printed with

        +
        +
        +
          +
        • +

          the Actor’s name,

          +
        • +
        • +

          the Task’s/Question’s toString output,

          +
        • +
        • +

          the result (success = , failure = , each retry = ),

          +
        • +
        • +

          the action’s duration (e.g. 245ms),

          +
        • +
        • +

          in case of a failure the causing exception’s simple class name (e.g. ElementNotFoundException),

          +
        • +
        • +

          in case of a successful question the given answer (e.g. → answer)

          +
        • +
        +
        +
        +

        Sub Tasks and Questions are printed as a hierarchic tree.

        +
        +
        +
        Slf4jReporter example output
        +
        +
        19:45:18.359 [Test worker] WARN Logan - Logan does login ✓ 1s15ms
        +├── Logan does enter username ✓ 312ms
        +├── Logan does enter password ✓ 432ms
        +└── Logan does submit login form ✓ 43ms
        +    └── Logan does confirm terms and conditions •✗ 245ms ElementNotFoundException
        +19:45:19.876 [Test worker] INFO Logan - Logan checks login state ✓ 1s15ms → false
        +
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/08-selenium.html b/docs/v0.8.1/manual/chapters/08-selenium.html new file mode 100644 index 00000000..d8860830 --- /dev/null +++ b/docs/v0.8.1/manual/chapters/08-selenium.html @@ -0,0 +1,832 @@ + + + + + + + +Browser Automation with Selenium + + + + + + + + +
        +
        +
        +
        +

        The Selenium Module provides the BrowseTheWeb Ability, which basically provides a managed Selenium WebDriver.

        +
        +
        +

        The Ability not only warps a WebDriver, but also manages it using a WebDriverSupplier which comes in different flavors for different scenarios (e.g. local debugging or continuous integration).

        +
        +
        +
        +
        +

        Setup

        +
        +
        +

        For Local Development

        +
        +

        When you write your UI tests locally, it is quite useful (and also satisfying) to be able to watch the automation work in a local browser, checking the browser’s developer and logs. +For this Shakespeare comes with the LocalWebDriverSupplier, which relies on a local installation of the browser.

        +
        +
        +

        It does take care of downloading the required binary, starting the browser as soon as the Actor actually uses it and closing it after the test case.

        +
        +
        +
        Java
        +
        +
        var tim =
        +    new Actor("Tim").can(new BrowseTheWeb(new LocalWebDriverSupplier(BrowserType.CHROME)));
        +
        +
        +
        +
        Kotlin
        +
        +
        val tim = Actor("Tim").can(BrowseTheWeb(LocalWebDriverSupplier(BrowserType.CHROME)))
        +
        +
        +
        +
        +

        Using WebDriverManager

        +
        +

        The above variant relies on the WebDriverManager internally.

        +
        +
        +

        WebDriverManagerWebDriverSupplier allows to use it directly and thereby use all of its features.

        +
        +
        +
        Java
        +
        +
        var webDriverManager = WebDriverManager.edgedriver().browserInDocker();
        +var alex =
        +    new Actor("Alex")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(webDriverManager, BrowserType.CHROME)));
        +
        +
        +
        +
        Kotlin
        +
        +
        val webDriverManager = WebDriverManager.edgedriver().browserInDocker()
        +val alex = Actor("Alex")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(webDriverManager, BrowserType.CHROME)
        +    )
        +  )
        +
        +
        +
        +
        +
        +
        +

        Base URL

        +
        +
        +

        Usually you will be testing one specific web application. +In order to reset the browser to the URL of that application, you can give that base URL as an additional parameter to the WebDriverManager. +The URL will be automatically called when you call getWebDriver.

        +
        +
        +
        Java
        +
        +
        var browseTheWeb = new BrowseTheWeb(webDriverSupplier, "https://shakespeareframework.org/");
        +
        +assertThat(browseTheWeb.getWebDriver().getCurrentUrl())
        +    .isEqualTo("https://shakespeareframework.org/");
        +
        +
        +
        +
        Kotlin
        +
        +
        val browseTheWeb = BrowseTheWeb(webDriverSupplier, "https://shakespeareframework.org/")
        +
        +assertThat(browseTheWeb.webDriver.currentUrl)
        +  .isEqualTo("https://shakespeareframework.org/")
        +
        +
        +
        +
        +
        +

        Additional Capabilities

        +
        +
        +

        All WebDriverSuppliers provide a constructor, which allows configuring additional Capabilities.

        +
        +
        +
        Java
        +
        +
        var cameron =
        +    new Actor("Cameron")
        +        .can(
        +            new BrowseTheWeb(
        +                new LocalWebDriverSupplier(
        +                    BrowserType.CHROME, new ChromeOptions().addArguments("--headless"))));
        +
        +
        +
        +
        Kotlin
        +
        +
        val cameron = Actor("Cameron")
        +  .can(
        +    BrowseTheWeb(
        +      LocalWebDriverSupplier(
        +        BrowserType.CHROME, ChromeOptions().addArguments("--headless")
        +      )
        +    )
        +  )
        +
        +
        +
        +
        +
        +

        Selenium Reporting

        +
        +
        +

        Screenshot Reporting

        +
        +

        An actor can be instructed to inform ScreenshotReporter (see [Reporting]). +By default, this will create a screenshot of the current page whenever doing a Task or answering a Question needs to be retried or fails, but it can also be configured to report successes.

        +
        +
        +

        The screenshots can then be found at the configured reports path and are named <counter>-<actor>-<retry|failure|success>-<task|question string>.png, where the <task|question string> is a file system friendly version of the Task’s or Question’s toString(). +E.g. 001-imogen-success-latest_shakespeare_release_version.png.

        +
        +
        +
        Java
        +
        +
        var reportsPath = Path.of("build", "reports", "shakespeare");
        +var imogen =
        +    new Actor("Imogen")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(
        +                    WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX)))
        +        .informs(new ScreenshotReporter(reportsPath, true));
        +
        +imogen.checks(new LatestShakespeareReleaseVersion());
        +
        +assertThat(reportsPath.resolve("001-imogen-success-latest_shakespeare_release_version.png"))
        +    .isNotEmptyFile();
        +
        +
        +
        +
        Kotlin
        +
        +
        val reportsPath = Path.of("build", "reports", "shakespeare")
        +val imogen = Actor("Imogen")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(
        +        WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX
        +      )
        +    )
        +  )
        +  .informs(ScreenshotReporter(reportsPath, true))
        +
        +imogen.checks(LatestShakespeareReleaseVersion())
        +
        +assertThat(reportsPath.resolve("001-imogen-success-latest_shakespeare_release_version.png"))
        +  .isNotEmptyFile
        +
        +
        +
        +
        +

        HTML Snapshot Reports

        +
        +

        Similar to the Screenshot Reporting there’s also a HtmlSnapshotReporter, which captures the current page’s HTML snapshot.

        +
        +
        +
        Java
        +
        +
        var reportsPath = Path.of("build", "reports", "shakespeare");
        +var tim =
        +    new Actor("Tim")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(
        +                    WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX)))
        +        .informs(new HtmlSnapshotReporter(reportsPath, true));
        +
        +tim.checks(new LatestShakespeareReleaseVersion());
        +
        +assertThat(reportsPath.resolve("001-tim-success-latest_shakespeare_release_version.html"))
        +    .isNotEmptyFile();
        +
        +
        +
        +
        Kotlin
        +
        +
        val reportsPath = Path.of("build", "reports", "shakespeare")
        +val tim = Actor("Tim")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(
        +        WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX
        +      )
        +    )
        +  )
        +  .informs(HtmlSnapshotReporter(reportsPath, true))
        +
        +tim.checks(LatestShakespeareReleaseVersion())
        +
        +assertThat(reportsPath.resolve("001-tim-success-latest_shakespeare_release_version.html"))
        +  .isNotEmptyFile
        +
        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/09-retrofit.html b/docs/v0.8.1/manual/chapters/09-retrofit.html new file mode 100644 index 00000000..77d4f12f --- /dev/null +++ b/docs/v0.8.1/manual/chapters/09-retrofit.html @@ -0,0 +1,785 @@ + + + + + + + +HTTP API Testing with Retrofit + + + + + + + + +
        +
        +
        +
        +

        The Retrofit Module provides the CallHttpApis Ability, which allows building Retrofit-based HTTP API clients.

        +
        +
        +
        +
        +

        Declaring the API

        +
        +
        +

        In order to create a client, Retrofit requires an interface, which describes the API. +For this, please follow the instructions in the Retrofit "API Declaration" documentation chapter.

        +
        +
        +
        Java
        +
        +
        interface ActorsApi {
        +
        +  @GET("/actors")
        +  Call<List<ActorInfo>> getActors();
        +
        +  @GET("/actors/{id}/name")
        +  Call<String> getActorName(@Path("id") String id);
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        interface ActorsApi {
        +  @GET("/actors")
        +  fun getActors(): Call<List<ActorInfo>>
        +
        +  @GET("/actors/{id}/name")
        +  fun getActorName(@Path("id") id: String): Call<String>
        +}
        +
        +
        +
        +
        +
        +

        Building the Client

        +
        +
        +

        Once the API interface is declared, the client can be build.

        +
        +
        +

        For Scalar Bodies (Strings, Integers, Floats)

        +
        +
        Java
        +
        +
        record ActorName(String id) implements Question<String> {
        +
        +  @Override
        +  public String answerAs(Actor actor) {
        +    var actorsApiClient =
        +        actor
        +            .uses(CallHttpApis.class)
        +            .buildClient() // (1)
        +            .baseUrl(serviceUrl) // (2)
        +            .addScalarsConverterFactory() // (3)
        +            .build(ActorsApi.class); // (4)
        +    try {
        +      return actorsApiClient.getActorName(id).execute().body();
        +    } catch (IOException e) {
        +      throw new RuntimeException("%s failed".formatted(this), e);
        +    }
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class ActorName(val id: String) : Question<String> {
        +  override fun answerAs(actor: Actor): String {
        +    val actorsApiClient = actor
        +        .uses(CallHttpApis::class.java)
        +              .buildClient() // (1)
        +        .baseUrl(serviceUrl) // (2)
        +        .addScalarsConverterFactory() // (3)
        +        .build(ActorsApi::class.java) // (4)
        +    return try {
        +      actorsApiClient.getActorName(id).execute().body() ?: throw RuntimeException("No body")
        +    } catch (e: IOException) {
        +      throw RuntimeException("${this} failed", e)
        +    }
        +  }
        +}
        +
        +
        +
        +
          +
        1. +

          The getClient method returns a CallHttpApis.Builder,

          +
        2. +
        3. +

          configure the base URL of the service—​it will be put in front of the relative URLs in the API annotations,

          +
        4. +
        5. +

          add needed ConverterFactory to convert response/request bodies,

          +
        6. +
        7. +

          build the client for the given API declaration.

          +
        8. +
        +
        +
        +
        +

        For JSON Bodies

        +
        +
        Java
        +
        +
        record AllActors() implements Question<List<ActorInfo>> {
        +
        +  @Override
        +  public List<ActorInfo> answerAs(Actor actor) {
        +    var actorsApiClient =
        +        actor
        +            .uses(CallHttpApis.class)
        +            .buildClient()
        +            .baseUrl(serviceUrl)
        +            .addJacksonConverterFactory() // (1)
        +            .build(ActorsApi.class);
        +    try {
        +      return actorsApiClient.getActors().execute().body();
        +    } catch (IOException e) {
        +      throw new RuntimeException("%s failed".formatted(this), e);
        +    }
        +  }
        +}
        +
        +record ActorInfo(String id, String name) {} // (2)
        +
        +
        +
        +
        Kotlin
        +
        +
        class AllActors : Question<List<ActorInfo>> {
        +  override fun answerAs(actor: Actor): List<ActorInfo> {
        +    val actorsApiClient = actor
        +        .uses(CallHttpApis::class.java)
        +              .buildClient()
        +        .baseUrl(serviceUrl)
        +        .addJacksonConverterFactory(ObjectMapper().registerModule(kotlinModule())) // (1)
        +        .build(ActorsApi::class.java)
        +    return try {
        +      actorsApiClient.getActors().execute().body() ?: throw RuntimeException("No body")
        +    } catch (e: IOException) {
        +      throw RuntimeException("${this} failed", e)
        +    }
        +  }
        +}
        +
        +data class ActorInfo(val id: String, val name: String) // (2)
        +
        +
        +
        +
          +
        1. +

          By adding the JacksonConverterFactory, the client will be able to parse the JSON body

          +
        2. +
        3. +

          into an instance of ActorInfo.

          +
        4. +
        +
        +
        +
        +

        Other Converters

        +
        +

        Retrofit provides a number of other converters.

        +
        +
        +

        Shakespeare currently ships only with Jackson and Scalars, but you can add other ones. +To do so, add the required dependency to your project, and use the generic addConverterFactory method to add it to your client.

        +
        +
        +
        +
        +
        + + + \ No newline at end of file diff --git a/docs/v0.8.1/manual/chapters/diag-7a3e81e6682727c1b0fc0823c5b40be1.png b/docs/v0.8.1/manual/chapters/diag-7a3e81e6682727c1b0fc0823c5b40be1.png new file mode 100644 index 00000000..d0dd9098 Binary files /dev/null and b/docs/v0.8.1/manual/chapters/diag-7a3e81e6682727c1b0fc0823c5b40be1.png differ diff --git a/docs/v0.8.1/manual/diag-7a3e81e6682727c1b0fc0823c5b40be1.png b/docs/v0.8.1/manual/diag-7a3e81e6682727c1b0fc0823c5b40be1.png new file mode 100644 index 00000000..d0dd9098 Binary files /dev/null and b/docs/v0.8.1/manual/diag-7a3e81e6682727c1b0fc0823c5b40be1.png differ diff --git a/docs/v0.8.1/manual/index.html b/docs/v0.8.1/manual/index.html new file mode 100644 index 00000000..d3d1dc18 --- /dev/null +++ b/docs/v0.8.1/manual/index.html @@ -0,0 +1,2178 @@ + + + + + + + + + +Shakespeare Framework + + + + + + + + + + +
        +
        +

        Introduction

        +
        +
        +

        Shakespeare

        +
        +

        Shakespeare is a Java implementation of Screenplay. +It was mainly created to explain the basic concepts of Screenplay and hence is kept rather simple in its core.

        +
        +
        +
        +

        Screenplay

        +
        +

        A framework helping to write tests like screenplays. +It is based on the ideas from Page Objects Refactored by Antony Marcano, Andy Palmer & John Ferguson Smart, with Jan Molak.

        +
        +
        +

        Screenplay does not replace any testing framework like JUnit, TestNG, Spock, RSpec, Jasmine etc. +In fact, it works with any of these. +Screenplay rather structures complex test code in a different way that makes it

        +
        +
        +
          +
        • +

          more readably,

          +
        • +
        • +

          more reusable, and

          +
        • +
        • +

          more maintainable.

          +
        • +
        +
        +
        +

        It does that mainly by taking a user-centric and object-oriented view on things.

        +
        +
        +

        In screenplay a user is represented by as an Actor. +Actors can have Abilities. +These enable them to do Tasks or answer Questions.

        +
        +
        +
        +Diagram +
        +
        Figure 1. Screenplay Core Concepts
        +
        +
        +

        In screenplay each of these concepts—​Actor, Ability, Task and Question—​are objects which abstract from the actual actions.

        +
        +
        +

        Actions can be calling an API, clicking a link, fetching an email, waiting for something to appear. +All these tiny noisy details are hidden within the Task or Question objects.

        +
        +
        +
        +
        +
        +

        Getting Started

        +
        +
        +

        Requirements

        +
        +

        In oder to use Shakespeare you need a JDK 11 or higher.

        +
        +
        +
        +

        Dependencies

        +
        +

        To use Shakespeare in your own project, you need to add it as a dependency to your project.

        +
        +
        +
        Gradle
        +
        +
        implementation 'org.shakespeareframework:core:0.8.1'
        +
        +
        +
        +
        Gradle.kts
        +
        +
        implementation("org.shakespeareframework:core:0.8.1")
        +
        +
        +
        +
        Maven
        +
        +
        <dependency>
        +  <groupId>org.shakespeareframework</groupId>
        +  <artifactId>core</artifactId>
        +  <version>0.8.1</version>
        +</dependency>
        +
        +
        +
        + + + + + +
        + + +The core module is a transient dependency of any other module. +Hence, you don’t need to keep it once you add another module (e.g. selenium or retrofit) +
        +
        +
        +

        Bill of Materials

        +
        +

        If you want to use more than one module in the same project, you can use Shakespeare’s bill of materials (BOM) and omit the explicit version for the other modules.

        +
        +
        +
        Gradle
        +
        +
        implementation platform('org.shakespeareframework:bom:0.8.1')
        +implementation 'org.shakespeareframework:selenium'
        +implementation 'org.shakespeareframework:retrofit'
        +
        +
        +
        +
        Gradle.kts
        +
        +
        implementation(platform("org.shakespeareframework:bom:0.8.1"))
        +implementation("org.shakespeareframework:selenium")
        +implementation("org.shakespeareframework:retrofit")
        +
        +
        +
        +
        Maven
        +
        +
        <project>
        +  <!--…-->
        +  <dependencyManagement>
        +    <dependencies>
        +      <dependency>
        +        <groupId>org.shakespeareframework</groupId>
        +        <artifactId>bom</artifactId>
        +        <version>0.8.1</version>
        +        <type>pom</type>
        +        <scope>import</scope>
        +      </dependency>
        +    </dependencies>
        +  </dependencyManagement>
        +  <!-- … -->
        +  <dependencies>
        +    <dependency>
        +      <groupId>org.shakespeareframework</groupId>
        +      <artifactId>selenium</artifactId>
        +    </dependency>
        +    <dependency>
        +      <groupId>org.shakespeareframework</groupId>
        +      <artifactId>retrofit</artifactId>
        +    </dependency>
        +  </dependencies>
        +  <!-- … -->
        +</project>
        +
        +
        +
        +
        +
        +
        +
        +

        Actors with Abilities

        +
        +
        +

        Actors

        +
        +

        The central object in a Screenplay and Shakespeare is the Actor. +Actors represent something or someone that interacts with the system under test.

        +
        +
        +

        There can be any number of Actors in a Screenplay (Test). +To make different Actors easily identifiable, they have a name. +The name can be explicitly given or will be randomly assigned.

        +
        +
        +
        Java
        +
        +
        var robin = new Actor("Robin");
        +
        +
        +
        +
        Kotlin
        +
        +
        val robin = Actor("Robin")
        +
        +
        +
        +
        Java
        +
        +
        var user = new Actor();
        +
        +
        +
        +
        Kotlin
        +
        +
        val user = Actor()
        +
        +
        +
        +
        +

        Abilities

        +
        +

        Actors may use Abilities to interact with the system under test.

        +
        +
        +

        Ability is a simple marker interface. +Implementations should provide methods providing an object which allows interaction with the system under test. +If that object is being generated on demand or simply wrapped by the Ability is up to the implementation.

        +
        +
        +
        Java
        +
        +
        class Log implements Ability {
        +
        +  private final Logger logger;
        +
        +  Log(String name) {
        +    this.logger = Logger.getLogger(name);
        +  }
        +
        +  public Logger getLogger() {
        +    return logger;
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class Log(val name: String, val logger: Logger = Logger.getLogger(name)) : Ability
        +
        +
        +
        +

        To allow Actors to use an Ability it needs to be given to them via the can(Ability) method.

        +
        +
        +
        Java
        +
        +
        var anna = new Actor("Anna").can(new Log("Anna"));
        +
        +
        +
        +
        Kotlin
        +
        +
        val anna = Actor("Anna").can(Log("Anna"))
        +
        +
        +
        +

        To get an Ability from an Actor, there’s the uses(Class<? extends Ability>) method.

        +
        +
        +
        Java
        +
        +
        var log = anna.uses(Log.class);
        +log.getLogger().info("Hello World");
        +
        +
        +
        +
        Kotlin
        +
        +
        val log = anna.uses(Log::class.java)
        +log.logger.info("Hello World")
        +
        +
        +
        +
        +
        +
        +

        Doing Tasks

        +
        +
        +

        Tasks

        +
        +

        Tasks can be done by an Actor. +What the actor should do is defined in the performAs(Actor) method of the Task.

        +
        +
        +

        As the Actor is given as an argument, the Task implementation has access to the Actor’s Abilities via the uses(Class<? extends Ability>) method.

        +
        +
        +
        Java
        +
        +
        class SayHelloWorld implements Task {
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info("Hello World");
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        class SayHelloWorld() : Task {
        +  override fun performAs(actor: Actor) {
        +    val logger = actor.uses(Log::class.java).logger
        +    logger.info("Hello World")
        +  }
        +}
        +
        +
        +
        +
        Java
        +
        +
        tom.does(new SayHelloWorld());
        +
        +
        +
        +
        Kotlin
        +
        +
        tom.does(SayHelloWorld())
        +
        +
        +
        +
        +

        Tasks with Parameters

        +
        +

        Some tasks require data to be executed. +E.g. a SearchFor Task probably needs a query string, or an AddToCart Task might need a product identifier.

        +
        +
        +

        Such data can be added as properties of the Task.

        +
        +
        +
        Java
        +
        +
        class SayHello implements Task {
        +
        +  private final String to;
        +
        +  public SayHello(String to) {
        +    this.to = to;
        +  }
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info(String.format("Hello %s", to));
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class SayHello(val to: String) : Task {
        +  override fun performAs(actor: Actor) {
        +    val logger = actor.uses(Log::class.java).logger
        +    logger.info("Hello $to")
        +  }
        +}
        +
        +
        +
        +

        As Tasks should not change over time and should be reusable, it is also possible to declare them as Java Records—​given that you can use Java 17+ features.

        +
        +
        +

        Doing the Tasks is the same for Classes and Records.

        +
        +
        +
        Java
        +
        +
        record SayHelloAsRecord(String to) implements Task {
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var logger = actor.uses(Log.class).getLogger();
        +    logger.info(String.format("Hello %s", to));
        +  }
        +}
        +
        +
        +
        +
        Java
        +
        +
        alex.does(new SayHello("Shakespeare"));
        +alex.does(new SayHelloAsRecord("Shakespeare"));
        +
        +
        +
        +
        Kotlin
        +
        +
        alex.does(SayHello("Shakespeare"))
        +
        +
        +
        +
        +

        Lambdas as Tasks

        +
        +

        As Tasks only have one abstract method, they can be declared using Java’s Lambda syntax.

        +
        +
        +
        Java
        +
        +
        mila.does(she -> she.uses(Log.class).getLogger().info("Hi"));
        +
        +
        +
        +
        Kotlin
        +
        +
        mila.does { she -> she.uses(Log::class.java).logger.info("Hi") }
        +
        +
        +
        + + + + + +
        + + +A Task should group complex interactions into a semantic unit of work. +So declaring them as Lambdas might be useful for short-lived experiments or debugging, but is not generally advisable. +
        +
        +
        +
        +

        Abstraction Levels

        +
        +

        Tasks are a powerful tool. +A task can be as simple as clicking on a link and as complex as a double-opt-in registration process. +Finding the right abstraction can be hard. +This chapter contains some examples how to find the right level of abstraction for Tasks.

        +
        +
        +

        Grouping Interactions

        +
        +

        The simplest kind of Tasks are those who group simple interactions with the system under test.

        +
        +
        +

        Let’s take a Task to log in to a website. +This might consist of the following interactions with the website:

        +
        +
        +
        Java
        +
        +
        class Login implements Task {
        +
        +  private final String username;
        +  private final String password;
        +
        +  Login(String username, String password) {
        +    this.username = username;
        +    this.password = password;
        +  }
        +
        +  @Override
        +  public void performAs(Actor actor) {
        +    var webDriver = actor.uses(BrowseTheWeb.class).getWebDriver();
        +
        +    webDriver.get(mockWebServer.url("/").toString()); (1)
        +
        +    webDriver
        +        .findElement(By.name("username")) (2)
        +        .sendKeys(username); (3)
        +    webDriver
        +        .findElement(By.name("password")) (4)
        +        .sendKeys(password); (5)
        +    webDriver
        +        .findElement(By.cssSelector(".login button")) (6)
        +        .click(); (7)
        +  }
        +
        +  @Override
        +  public String toString() {
        +    return String.format("login as %s", username);
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class Login(private val username: String, private val password: String) : Task {
        +
        +  override fun performAs(actor: Actor) {
        +    val webDriver = actor.uses(BrowseTheWeb::class.java).webDriver
        +
        +    webDriver.get(mockWebServer.url("/").toString()) (1)
        +
        +    webDriver
        +      .findElement(By.name("username")) (2)
        +      .sendKeys(username) (3)
        +    webDriver
        +      .findElement(By.name("password")) (4)
        +      .sendKeys(password) (5)
        +    webDriver
        +      .findElement(By.cssSelector(".login button")) (6)
        +      .click() (7)
        +  }
        +
        +  override fun toString(): String {
        +    return "login as $username"
        +  }
        +}
        +
        +
        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        1Navigate to the website,
        2find the "username" input field,
        3write "john" into it,
        4find the "password" input field,
        5write "demo" into it,
        6find the login button,
        7click on it.
        +
        +
        +

        As you can see all the interactions are wrapped in the Task object. +It has fields for the username and the password, so we can easily reuse the Task with other credentials.

        +
        +
        +
        +

        Grouping Tasks

        +
        +

        As the Actor is fully injected into the performAs method, it is also possible to do other tasks in a Task.

        +
        +
        +

        Let’s take a shop website as an example. +In order to check out, there are several complex steps needed:

        +
        +
        +
          +
        1. +

          Add any product to the shopping cart,

          +
        2. +
        3. +

          navigate to the checkout page,

          +
        4. +
        5. +

          enter a delivery address,

          +
        6. +
        7. +

          enter valid payment details,

          +
        8. +
        9. +

          confirm the checkout.

          +
        10. +
        +
        +
        +

        All these steps could be Tasks in their own right, but if we want to test that the user is able to cancel the order after check out, we might want to bundle the steps into something like a Checkout Task.

        +
        +
        + + + + + +
        + + +It is generally a bad idea to mix simple interactions with sub-tasks, as it makes finding problems much harder! +
        +
        +
        +
        +
        +
        +
        +

        Checking Questions

        +
        +
        +

        Questions

        +
        +

        Questions are pretty similar to Tasks, but may return an answer.

        +
        +
        +

        They can be checked (answered) by an Actor. +How the Actor finds the answer to a Question is defined in the answerAs(Actor) method of the Question.

        +
        +
        +

        Similar to the performAs(Actor) method of the Task, the Actor is given as an argument, so a Question can use all the Actor’s Abilities to find the answer.

        +
        +
        +
        Java
        +
        +
        class LoggedInState implements Question<Boolean> {
        +
        +  @Override
        +  public Boolean answerAs(Actor actor) {
        +    var webDriver = actor.uses(BrowseTheWeb.class).getWebDriver();
        +
        +    return !webDriver.findElements(By.linkText("Log Out")).isEmpty();
        +  }
        +
        +  @Override
        +  public String toString() {
        +    return "login state";
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        class LoggedInState : Question<Boolean> {
        +
        +  override fun answerAs(actor: Actor): Boolean {
        +    val webDriver = actor.uses(BrowseTheWeb::class.java).webDriver
        +    return webDriver.findElements(By.linkText("Log Out")).isNotEmpty()
        +  }
        +
        +  override fun toString(): String {
        +    return "login state"
        +  }
        +}
        +
        +
        +
        +

        While it is possible to put complex interactions in Questions it is generally advisable to keep them simple and independent.

        +
        +
        +

        Good Questions

        +
        +

        Undoubtedly good questions do not change the state of the system under test in any way

        +
        +
        +
          +
        • +

          Checking a web element is present,

          +
        • +
        • +

          performing a GET call on an HTTP API and return its body,

          +
        • +
        • +

          fetching email and retuning its content.

          +
        • +
        +
        +
        +
        +

        Ugly Questions

        +
        +

        Doubtfully ugly questions don’t change the persisted state of the system under test, but change the local state. +For example the current displayed view. +Using such questions requires to check the state in following Tasks or Questions.

        +
        +
        +
          +
        • +

          Navigate to the user’s profile page to check for data that is only visible there,

          +
        • +
        • +

          checking available products by switching to the search results page.

          +
        • +
        +
        +
        +

        Especially in web applications this type of Questions are often unavoidable, but should be kept to a minimum.

        +
        +
        +
        +

        Bad Questions

        +
        +

        Changing the persistent state of the system under test should genrally be avoided and be left to Tasks.

        +
        +
        +
          +
        • +

          Sending data to a backend API,

          +
        • +
        • +

          login to a web application,

          +
        • +
        • +

          deleting email.

          +
        • +
        +
        +
        +
        +
        +
        +
        +

        Retryables

        +
        +
        +

        Some things take time. +E.g. after creating an account, it might take some time for a confirmation email to arrive.

        +
        +
        +

        Shakespeare provides a generic way to wait for things to succeed: Retryables.

        +
        +
        +

        They can be used just like regular Tasks and Questions, but they additionally have a defined timeout after which an Actor will give up and an interval in which an Actor will retry. +The default timeout is 2 seconds, the default interval is the 10th of the timeout.

        +
        +
        + + + + + +
        + + +Shakespeare’s Retryables are meant for things that a human user would need to retry as well. +To wait for UI elements to show up, there are better usually more efficient ways available (e.g. in Selenium, Cypress etc.). +
        +
        +
        +

        Retryable Tasks

        +
        +

        A RetryableTask also has a set of acknowledged exceptions. +By default, an Actor will ignore all Exceptions thrown in retries, but will immediately fail if it is an instance of an acknowledged Exception.

        +
        +
        +

        E.g. you might expect a NotFoundException but not a AuthorizationFailedException. +So you can just add the latter to the acknowledgedExceptions.

        +
        +
        +
        +

        Retryable Questions

        +
        +

        A RetryableQuestion has a set of ignored Exceptions and an acceptable method. +While any Exception thrown that is not in the set of ignored exceptions will break the retrying loop, the acceptable method will be called for each yielded answer. +Only if the acceptable method returns true, the retrying will stop and return the (accepted) answer.

        +
        +
        +

        There is a default implementation of acceptable, which will a number of possible answers:

        +
        +
        +
          +
        1. +

          Optionals that are present,

          +
        2. +
        3. +

          non-empty Collections, Maps or Arrays,

          +
        4. +
        5. +

          any Boolean answer, and

          +
        6. +
        7. +

          anything that not null.

          +
        8. +
        +
        +
        +

        Checked in that order.

        +
        +
        +

        This default implementation might suit your needs already, but you can always override it with your own logic.

        +
        +
        +
        +
        +
        +

        Learning & Remembering Facts

        +
        +
        +

        Facts are a way to add data to the Actor. +After a Fact was learned, it can always be remembered by its class and be used to do Tasks or answer Questions.

        +
        +
        +
        Java
        +
        +
        kate.learns(new PhoneNumber("+49 0180 4 100 100"));
        +
        +PhoneNumber katesPhoneNumber = kate.remembers(PhoneNumber.class);
        +
        +
        +
        +
        Kotlin
        +
        +
        kate.learns(PhoneNumber("+49 0180 4 100 100"))
        +
        +val katesPhoneNumber = kate.remembers(PhoneNumber::class.java)
        +
        +
        +
        +

        Fact classes only need to implement the (empty) Fact marker interface. +Apart from that they can be basically anything but should be immutable value objects or records.

        +
        +
        +
        Java
        +
        +
        record PhoneNumber(String number) implements Fact {}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class PhoneNumber(val number: String) : Fact
        +
        +
        +
        +

        Relearning Facts

        +
        +

        Note that an Actor cannot remember multiple instances of a Fact. +When you call remember with two different instances of the same Fact class, the older one is being forgotten and replaced by the new one.

        +
        +
        +
        Java
        +
        +
        kate.learns(new PhoneNumber("+49 0180 4 100 100"));
        +
        +kate.learns(new PhoneNumber("+1 (303) 499-7111"));
        +
        +PhoneNumber katesNewPhoneNumber = kate.remembers(PhoneNumber.class);
        +assertThat(katesNewPhoneNumber).isEqualTo(new PhoneNumber("+1 (303) 499-7111"));
        +
        +
        +
        +
        Kotlin
        +
        +
        kate.learns(PhoneNumber("+49 0180 4 100 100"))
        +
        +kate.learns(PhoneNumber("+1 (303) 499-7111"))
        +
        +val katesNewPhoneNumber = kate.remembers(PhoneNumber::class.java)
        +assertThat(katesNewPhoneNumber).isEqualTo(PhoneNumber("+1 (303) 499-7111"))
        +
        +
        +
        +
        +

        Poly Facts

        +
        +

        One way to achieve something similar are Poly Facts: Simply Facts with multiple fields.

        +
        +
        +

        E.g. a PhoneNumbers Fact might contain a field for a work phone number and one for a home phone number:

        +
        +
        +
        Java
        +
        +
        record PhoneNumbers(String home, String work) implements Fact {}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class PhoneNumbers(val home: String, val work: String) : Fact
        +
        +
        +
        +
        Java
        +
        +
        robin.learns(new PhoneNumbers("+49 0180 4 100 100", "+1 (303) 499-7111"));
        +
        +var robinsPhoneNumbers = robin.remembers(PhoneNumbers.class);
        +var robinsHomePhoneNumber = robinsPhoneNumbers.home();
        +var robinsWorkPhoneNumber = robinsPhoneNumbers.work();
        +
        +
        +
        +
        Kotlin
        +
        +
        robin.learns(PhoneNumbers(home = "+49 0180 4 100 100", work = "+1 (303) 499-7111"))
        +
        +val robinsPhoneNumbers = robin.remembers(PhoneNumbers::class.java)
        +val robinsHomePhoneNumber = robinsPhoneNumbers.home
        +val robinsWorkPhoneNumber = robinsPhoneNumbers.work
        +
        +
        +
        +
        +

        Facts with Defaults and Generators

        +
        +

        One great advantage of Fact classes is the possibility of adding static fields and methods.

        +
        +
        +

        E.g. you can put that one valid test credit card number in a public static CreditCard DEFAULT in your CreditCard Fact class:

        +
        +
        +
        Java
        +
        +
        record CreditCard(String type, String number, YearMonth expiration) implements Fact {
        +  public static CreditCard DEFAULT_VISA =
        +      new CreditCard("visa", "4111111111111111", YearMonth.of(2026, 10));
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class CreditCard(val type: String, val number: String, val expiration: YearMonth) : Fact {
        +  companion object {
        +    val DEFAULT_VISA =
        +      CreditCard("visa", "4111111111111111", YearMonth.of(2026, 10))
        +  }
        +}
        +
        +
        +
        +

        Or you can add a method to generate valid unique random email addresses to your EmailAddress Fact class:

        +
        +
        +
        Java
        +
        +
        record EmailAddress(String address) implements Fact {
        +  public static EmailAddress random() {
        +    return new EmailAddress("%s@shakespeareframework.org".formatted(UUID.randomUUID()));
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class EmailAddress(val address: String) : Fact {
        +  companion object {
        +    fun random() = EmailAddress("${UUID.randomUUID()}@shakespeareframework.org")
        +  }
        +}
        +
        +
        +
        +
        +

        Personalized Tasks/Questions

        +
        +

        Facts can be used to provide an Actor with necessary information for certain Tasks and Questions instead of using Tasks with Parameters.

        +
        +
        +

        By doing so, we can instruct an Actors to do something with their memory as context.

        +
        +
        +

        For example, to create an account we usually require a lot of personal information. +To human testers, I can say "go create an account", and they will use their own data to do that. +Using Facts we can achieve the same feel of a personal context.

        +
        +
        +

        In that case, an Actors learn their facts in the setup phase of a test.

        +
        +
        + + + + + +
        + + +Using Facts in your Tasks and Questions can be a really nice experience. +You don’t need to keep your test data at hand in you test code, but can confine it in the test’s setup phase. +However, by doing so you might end up scrolling back and forth in order to understand a failing test. +So you really want to limit this to data that is really owned by an Actor. +
        +
        +
        +
        +

        Learning by Doing

        +
        +

        Another possible use case for Facts is to learn things while doing things. +E.g. after finishing a shop’s checkout process it might be useful to remember the displayed order number.

        +
        +
        +

        In that case the Facts are learned as a side effect of a Task or a Question.

        +
        +
        + + + + + +
        + + +Don’t overdo this! +Side effects are not easy to keep track of. +
        +
        +
        +
        +
        +
        +

        Reporting

        +
        +
        +

        Actors can report actions and their outcome via Reporters that can be added using the link:../javadoc/core/org/shakespeareframework/Actor.html#informs(org.shakespeareframework.reporting.Reporter…​))[informs(Reporter…​) method.

        +
        +
        +

        Actors call each of their Reporters in the declared order for the following events:

        +
        +
        +
          +
        • +

          When starting to do a Task or answer a Question,

          +
        • +
        • +

          when retrying a RetryableTask or RetryableQuestion,

          +
        • +
        • +

          when successfully finishing a Task or successfully answering a Question,

          +
        • +
        • +

          when failing to do a Task or answer a Question.

          +
        • +
        +
        +
        +

        Built-In Reporters

        +
        +

        The Slf4jReporter

        +
        +

        Uses the Slf4j Logger to print each action of the Actor. +Successful actions will be logged as info, failure as warnings. +Note that actions are only logged after finishing.

        +
        +
        +

        Each action is printed with

        +
        +
        +
          +
        • +

          the Actor’s name,

          +
        • +
        • +

          the Task’s/Question’s toString output,

          +
        • +
        • +

          the result (success = , failure = , each retry = ),

          +
        • +
        • +

          the action’s duration (e.g. 245ms),

          +
        • +
        • +

          in case of a failure the causing exception’s simple class name (e.g. ElementNotFoundException),

          +
        • +
        • +

          in case of a successful question the given answer (e.g. → answer)

          +
        • +
        +
        +
        +

        Sub Tasks and Questions are printed as a hierarchic tree.

        +
        +
        +
        Slf4jReporter example output
        +
        +
        19:45:18.359 [Test worker] WARN Logan - Logan does login ✓ 1s15ms
        +├── Logan does enter username ✓ 312ms
        +├── Logan does enter password ✓ 432ms
        +└── Logan does submit login form ✓ 43ms
        +    └── Logan does confirm terms and conditions •✗ 245ms ElementNotFoundException
        +19:45:19.876 [Test worker] INFO Logan - Logan checks login state ✓ 1s15ms → false
        +
        +
        +
        +
        +
        +
        +
        +

        Additional Modules

        +
        +
        +

        Browser Automation with Selenium

        +
        +

        The Selenium Module provides the BrowseTheWeb Ability, which basically provides a managed Selenium WebDriver.

        +
        +
        +

        The Ability not only warps a WebDriver, but also manages it using a WebDriverSupplier which comes in different flavors for different scenarios (e.g. local debugging or continuous integration).

        +
        +
        +

        Setup

        +
        +
        For Local Development
        +
        +

        When you write your UI tests locally, it is quite useful (and also satisfying) to be able to watch the automation work in a local browser, checking the browser’s developer and logs. +For this Shakespeare comes with the LocalWebDriverSupplier, which relies on a local installation of the browser.

        +
        +
        +

        It does take care of downloading the required binary, starting the browser as soon as the Actor actually uses it and closing it after the test case.

        +
        +
        +
        Java
        +
        +
        var tim =
        +    new Actor("Tim").can(new BrowseTheWeb(new LocalWebDriverSupplier(BrowserType.CHROME)));
        +
        +
        +
        +
        Kotlin
        +
        +
        val tim = Actor("Tim").can(BrowseTheWeb(LocalWebDriverSupplier(BrowserType.CHROME)))
        +
        +
        +
        +
        +
        Using WebDriverManager
        +
        +

        The above variant relies on the WebDriverManager internally.

        +
        +
        +

        WebDriverManagerWebDriverSupplier allows to use it directly and thereby use all of its features.

        +
        +
        +
        Java
        +
        +
        var webDriverManager = WebDriverManager.edgedriver().browserInDocker();
        +var alex =
        +    new Actor("Alex")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(webDriverManager, BrowserType.CHROME)));
        +
        +
        +
        +
        Kotlin
        +
        +
        val webDriverManager = WebDriverManager.edgedriver().browserInDocker()
        +val alex = Actor("Alex")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(webDriverManager, BrowserType.CHROME)
        +    )
        +  )
        +
        +
        +
        +
        +
        +

        Base URL

        +
        +

        Usually you will be testing one specific web application. +In order to reset the browser to the URL of that application, you can give that base URL as an additional parameter to the WebDriverManager. +The URL will be automatically called when you call getWebDriver.

        +
        +
        +
        Java
        +
        +
        var browseTheWeb = new BrowseTheWeb(webDriverSupplier, "https://shakespeareframework.org/");
        +
        +assertThat(browseTheWeb.getWebDriver().getCurrentUrl())
        +    .isEqualTo("https://shakespeareframework.org/");
        +
        +
        +
        +
        Kotlin
        +
        +
        val browseTheWeb = BrowseTheWeb(webDriverSupplier, "https://shakespeareframework.org/")
        +
        +assertThat(browseTheWeb.webDriver.currentUrl)
        +  .isEqualTo("https://shakespeareframework.org/")
        +
        +
        +
        +
        +

        Additional Capabilities

        +
        +

        All WebDriverSuppliers provide a constructor, which allows configuring additional Capabilities.

        +
        +
        +
        Java
        +
        +
        var cameron =
        +    new Actor("Cameron")
        +        .can(
        +            new BrowseTheWeb(
        +                new LocalWebDriverSupplier(
        +                    BrowserType.CHROME, new ChromeOptions().addArguments("--headless"))));
        +
        +
        +
        +
        Kotlin
        +
        +
        val cameron = Actor("Cameron")
        +  .can(
        +    BrowseTheWeb(
        +      LocalWebDriverSupplier(
        +        BrowserType.CHROME, ChromeOptions().addArguments("--headless")
        +      )
        +    )
        +  )
        +
        +
        +
        +
        +

        Selenium Reporting

        +
        +
        Screenshot Reporting
        +
        +

        An actor can be instructed to inform ScreenshotReporter (see Reporting). +By default, this will create a screenshot of the current page whenever doing a Task or answering a Question needs to be retried or fails, but it can also be configured to report successes.

        +
        +
        +

        The screenshots can then be found at the configured reports path and are named <counter>-<actor>-<retry|failure|success>-<task|question string>.png, where the <task|question string> is a file system friendly version of the Task’s or Question’s toString(). +E.g. 001-imogen-success-latest_shakespeare_release_version.png.

        +
        +
        +
        Java
        +
        +
        var reportsPath = Path.of("build", "reports", "shakespeare");
        +var imogen =
        +    new Actor("Imogen")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(
        +                    WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX)))
        +        .informs(new ScreenshotReporter(reportsPath, true));
        +
        +imogen.checks(new LatestShakespeareReleaseVersion());
        +
        +assertThat(reportsPath.resolve("001-imogen-success-latest_shakespeare_release_version.png"))
        +    .isNotEmptyFile();
        +
        +
        +
        +
        Kotlin
        +
        +
        val reportsPath = Path.of("build", "reports", "shakespeare")
        +val imogen = Actor("Imogen")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(
        +        WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX
        +      )
        +    )
        +  )
        +  .informs(ScreenshotReporter(reportsPath, true))
        +
        +imogen.checks(LatestShakespeareReleaseVersion())
        +
        +assertThat(reportsPath.resolve("001-imogen-success-latest_shakespeare_release_version.png"))
        +  .isNotEmptyFile
        +
        +
        +
        +
        +
        HTML Snapshot Reports
        +
        +

        Similar to the Screenshot Reporting there’s also a HtmlSnapshotReporter, which captures the current page’s HTML snapshot.

        +
        +
        +
        Java
        +
        +
        var reportsPath = Path.of("build", "reports", "shakespeare");
        +var tim =
        +    new Actor("Tim")
        +        .can(
        +            new BrowseTheWeb(
        +                new WebDriverManagerWebDriverSupplier(
        +                    WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX)))
        +        .informs(new HtmlSnapshotReporter(reportsPath, true));
        +
        +tim.checks(new LatestShakespeareReleaseVersion());
        +
        +assertThat(reportsPath.resolve("001-tim-success-latest_shakespeare_release_version.html"))
        +    .isNotEmptyFile();
        +
        +
        +
        +
        Kotlin
        +
        +
        val reportsPath = Path.of("build", "reports", "shakespeare")
        +val tim = Actor("Tim")
        +  .can(
        +    BrowseTheWeb(
        +      WebDriverManagerWebDriverSupplier(
        +        WebDriverManager.firefoxdriver().browserInDocker(), BrowserType.FIREFOX
        +      )
        +    )
        +  )
        +  .informs(HtmlSnapshotReporter(reportsPath, true))
        +
        +tim.checks(LatestShakespeareReleaseVersion())
        +
        +assertThat(reportsPath.resolve("001-tim-success-latest_shakespeare_release_version.html"))
        +  .isNotEmptyFile
        +
        +
        +
        +
        +
        +
        +

        HTTP API Testing with Retrofit

        +
        +

        The Retrofit Module provides the CallHttpApis Ability, which allows building Retrofit-based HTTP API clients.

        +
        +
        +

        Declaring the API

        +
        +

        In order to create a client, Retrofit requires an interface, which describes the API. +For this, please follow the instructions in the Retrofit "API Declaration" documentation chapter.

        +
        +
        +
        Java
        +
        +
        interface ActorsApi {
        +
        +  @GET("/actors")
        +  Call<List<ActorInfo>> getActors();
        +
        +  @GET("/actors/{id}/name")
        +  Call<String> getActorName(@Path("id") String id);
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        interface ActorsApi {
        +  @GET("/actors")
        +  fun getActors(): Call<List<ActorInfo>>
        +
        +  @GET("/actors/{id}/name")
        +  fun getActorName(@Path("id") id: String): Call<String>
        +}
        +
        +
        +
        +
        +

        Building the Client

        +
        +

        Once the API interface is declared, the client can be build.

        +
        +
        +
        For Scalar Bodies (Strings, Integers, Floats)
        +
        +
        Java
        +
        +
        record ActorName(String id) implements Question<String> {
        +
        +  @Override
        +  public String answerAs(Actor actor) {
        +    var actorsApiClient =
        +        actor
        +            .uses(CallHttpApis.class)
        +            .buildClient() (1)
        +            .baseUrl(serviceUrl) (2)
        +            .addScalarsConverterFactory() (3)
        +            .build(ActorsApi.class); (4)
        +    try {
        +      return actorsApiClient.getActorName(id).execute().body();
        +    } catch (IOException e) {
        +      throw new RuntimeException("%s failed".formatted(this), e);
        +    }
        +  }
        +}
        +
        +
        +
        +
        Kotlin
        +
        +
        data class ActorName(val id: String) : Question<String> {
        +  override fun answerAs(actor: Actor): String {
        +    val actorsApiClient = actor
        +        .uses(CallHttpApis::class.java)
        +              .buildClient() (1)
        +        .baseUrl(serviceUrl) (2)
        +        .addScalarsConverterFactory() (3)
        +        .build(ActorsApi::class.java) (4)
        +    return try {
        +      actorsApiClient.getActorName(id).execute().body() ?: throw RuntimeException("No body")
        +    } catch (e: IOException) {
        +      throw RuntimeException("${this} failed", e)
        +    }
        +  }
        +}
        +
        +
        +
        + + + + + + + + + + + + + + + + + +
        1The getClient method returns a CallHttpApis.Builder,
        2configure the base URL of the service—​it will be put in front of the relative URLs in the API annotations,
        3add needed ConverterFactory to convert response/request bodies,
        4build the client for the given API declaration.
        +
        +
        +
        +
        For JSON Bodies
        +
        +
        Java
        +
        +
        record AllActors() implements Question<List<ActorInfo>> {
        +
        +  @Override
        +  public List<ActorInfo> answerAs(Actor actor) {
        +    var actorsApiClient =
        +        actor
        +            .uses(CallHttpApis.class)
        +            .buildClient()
        +            .baseUrl(serviceUrl)
        +            .addJacksonConverterFactory() (1)
        +            .build(ActorsApi.class);
        +    try {
        +      return actorsApiClient.getActors().execute().body();
        +    } catch (IOException e) {
        +      throw new RuntimeException("%s failed".formatted(this), e);
        +    }
        +  }
        +}
        +
        +record ActorInfo(String id, String name) {} (2)
        +
        +
        +
        +
        Kotlin
        +
        +
        class AllActors : Question<List<ActorInfo>> {
        +  override fun answerAs(actor: Actor): List<ActorInfo> {
        +    val actorsApiClient = actor
        +        .uses(CallHttpApis::class.java)
        +              .buildClient()
        +        .baseUrl(serviceUrl)
        +        .addJacksonConverterFactory(ObjectMapper().registerModule(kotlinModule())) (1)
        +        .build(ActorsApi::class.java)
        +    return try {
        +      actorsApiClient.getActors().execute().body() ?: throw RuntimeException("No body")
        +    } catch (e: IOException) {
        +      throw RuntimeException("${this} failed", e)
        +    }
        +  }
        +}
        +
        +data class ActorInfo(val id: String, val name: String) (2)
        +
        +
        +
        + + + + + + + + + +
        1By adding the JacksonConverterFactory, the client will be able to parse the JSON body
        2into an instance of ActorInfo.
        +
        +
        +
        +
        Other Converters
        +
        +

        Retrofit provides a number of other converters.

        +
        +
        +

        Shakespeare currently ships only with Jackson and Scalars, but you can add other ones. +To do so, add the required dependency to your project, and use the generic addConverterFactory method to add it to your client.

        +
        +
        +
        +
        +
        +
        + +
        + + + + + + + + + \ No newline at end of file