Skip navigation links
A B C D E F G H I N O P R S T U V W 

A

addChild(TestBlockRunner) - Method in class org.forgerock.cuppa.internal.TestBlockRunner
Adds a runner for a child test block.
after(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed once, after all tests in the current and nested blocks.
after(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed once, after all tests in the current block.
after(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'after' block to be run.
after(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'after' block to be run.
afterEach(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed after each test in the current and nested blocks.
afterEach(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed after each test in the current and nested blocks.
afterEach(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'afterEach' block to be run.
afterEach(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'afterEach' block to be run.
AndCondition - Class in org.forgerock.cuppa.transforms.expression
A condition that composes other conditions with a logical AND.
apply() - Method in interface org.forgerock.cuppa.functions.HookFunction
Defines the behaviour of a test hook.
apply() - Method in interface org.forgerock.cuppa.functions.TestBlockFunction
Defines a set of tests by calling Cuppa.it(String, TestFunction) and/or defines nested blocks by calling Cuppa.describe(String, TestBlockFunction) or Cuppa.when(String, TestBlockFunction).
apply() - Method in interface org.forgerock.cuppa.functions.TestFunction
Defines the behaviour of the test.
apply(TestBlock) - Method in class org.forgerock.cuppa.internal.filters.EmptyTestBlockFilter
 
apply(TestBlock) - Method in class org.forgerock.cuppa.internal.filters.OnlyTestBlockFilter
 
apply(TestBlock) - Method in class org.forgerock.cuppa.transforms.ExpressionTagTestBlockFilter
 
apply(TestBlock) - Method in class org.forgerock.cuppa.transforms.TagTestBlockFilter
 

B

before(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed once, before any tests in the current and nested blocks.
before(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed once, before any tests in the current and nested blocks.
before(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'before' block to be run.
before(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'before' block to be run.
beforeEach(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed before each test in the current and nested blocks.
beforeEach(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers the given function to be executed before each test in the current and nested blocks.
beforeEach(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'beforeEach' block to be run.
beforeEach(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'beforeEach' block to be run.
Behaviour - Enum in org.forgerock.cuppa.model
Controls the behaviour of a test or collection of tests.
behaviour - Variable in class org.forgerock.cuppa.model.Test
Controls how the test behaves.
behaviour - Variable in class org.forgerock.cuppa.model.TestBlock
Controls how the test block and its descendants behave.
blockHookFail(Hook, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
blockHookFail(Hook, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
blockHookFail(Hook, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called when a before or after hook failed due to it throwing an exception.
blockHookPass(Hook, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
blockHookPass(Hook, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after a before or after hook has successfully executed without throwing an exception.
blockHookStart(Hook, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
blockHookStart(Hook, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called before a before or after hook is run.
build() - Method in class org.forgerock.cuppa.model.HookBuilder
Constructs a Hook using the values set on this builder.
build() - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Constructs a TestBlock using the values set on this builder.
build() - Method in class org.forgerock.cuppa.model.TestBuilder
Constructs a Test using the values set on this builder.

C

combine(Behaviour) - Method in enum org.forgerock.cuppa.model.Behaviour
Combine this behaviour with another behaviour.
CompositeReporter - Class in org.forgerock.cuppa.reporters
A reporter that delegates to list of other reporters.
CompositeReporter(List<Reporter>) - Constructor for class org.forgerock.cuppa.reporters.CompositeReporter
Constructs a new composite reporter.
Condition - Interface in org.forgerock.cuppa.transforms.expression
A condition used by ExpressionTagTestBlockFilter.
ConditionFactory - Class in org.forgerock.cuppa.transforms.expression
A factory to creates ConditionWrapper.
Configuration - Class in org.forgerock.cuppa
Holds configuration settings for Cuppa.
ConfigurationProvider - Interface in org.forgerock.cuppa
Provides configuration for Cuppa at runtime.
configure(Configuration) - Method in interface org.forgerock.cuppa.ConfigurationProvider
Should configure Cuppa using the provided Configuration.
ContainsCondition - Class in org.forgerock.cuppa.transforms.expression
A condition that checks if a tag is contains in a collection of tags.
Cuppa - Class in org.forgerock.cuppa
Use the methods of this class to define your tests.
CuppaException - Exception in org.forgerock.cuppa
Thrown to indicate that an error occurred whilst running Cuppa tests.
CuppaException(String, Throwable) - Constructor for exception org.forgerock.cuppa.CuppaException
Constructs a new Cuppa exception with the given message and cause.
CuppaException(String) - Constructor for exception org.forgerock.cuppa.CuppaException
Constructs a new Cuppa exception with the given message.

D

DefaultReporter - Class in org.forgerock.cuppa.reporters
An RSpec-like reporter.
DefaultReporter() - Constructor for class org.forgerock.cuppa.reporters.DefaultReporter
Constructs a reporter that writes to standard out.
DefaultReporter(OutputStream) - Constructor for class org.forgerock.cuppa.reporters.DefaultReporter
Constructs a reporter that writes to the specified stream, using the JVM's default charset.
DefaultReporter(OutputStream, Charset) - Constructor for class org.forgerock.cuppa.reporters.DefaultReporter
Constructs a reporter that writes to the specified stream.
defineTests(Class<?>, Runnable) - Method in enum org.forgerock.cuppa.internal.TestContainer
Define tests within the context of a test class.
defineTests(Iterable<Class<?>>) - Method in class org.forgerock.cuppa.Runner
Instantiates the test classes, which define tests as side effects, and return the root test block.
defineTests(Runnable) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Define some Cuppa tests.
describe(String, TestBlockFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers a 'describe' block of tests.
describe(String, TestBlockFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a described suite of tests to be run.
describe(String, TestBlockFunction) - Method in interface org.forgerock.cuppa.TestBuilder
Registers a described suite of tests to be run.
description - Variable in class org.forgerock.cuppa.model.Hook
An optional description.
description - Variable in enum org.forgerock.cuppa.model.HookType
The method name of the hook.
description - Variable in class org.forgerock.cuppa.model.Test
The description of the test.
description - Variable in class org.forgerock.cuppa.model.TestBlock
The description of the test block.

E

EMPTY - Static variable in class org.forgerock.cuppa.model.Options
The empty option set.
EMPTY - Static variable in class org.forgerock.cuppa.transforms.expression.AndCondition
An empty AND definition.
EMPTY - Static variable in class org.forgerock.cuppa.transforms.expression.NotCondition
An empty NOT definition.
EMPTY - Static variable in class org.forgerock.cuppa.transforms.expression.OrCondition
An empty OR definition.
EMPTY_TAGS - Static variable in class org.forgerock.cuppa.model.Tags
No tags specified, meaning no tests should be filtered from the test run.
EmptyTestBlockFilter - Class in org.forgerock.cuppa.internal.filters
Filter out test blocks that do not contain any tests.
EmptyTestBlockFilter() - Constructor for class org.forgerock.cuppa.internal.filters.EmptyTestBlockFilter
 
end() - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
end() - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
end() - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after all tests have been run.
equals(Object) - Method in class org.forgerock.cuppa.model.Hook
 
equals(Object) - Method in class org.forgerock.cuppa.model.Option
 
equals(Object) - Method in class org.forgerock.cuppa.model.Options
 
equals(Object) - Method in class org.forgerock.cuppa.model.Test
 
equals(Object) - Method in class org.forgerock.cuppa.model.TestBlock
 
excludedTags - Variable in class org.forgerock.cuppa.model.Tags
The set of excluded tags which tests must not be tagged with to be included in the test run.
excludedTags(Set<String>) - Static method in class org.forgerock.cuppa.model.Tags
Constructs a Tags instance with the specified anti-tags (excluded tags).
ExpressionParser - Class in org.forgerock.cuppa.transforms.expression
This class is responsible to parse an expression tag to a Condition .
expressionTags - Variable in class org.forgerock.cuppa.model.Tags
An expression of tags using condition to create complex tag filtering.
expressionTags(String) - Static method in class org.forgerock.cuppa.model.Tags
Constructs a Tags instance with the specified expression tag.
ExpressionTagTestBlockFilter - Class in org.forgerock.cuppa.transforms
Filter the tests according to the expression tag.
ExpressionTagTestBlockFilter(Tags) - Constructor for class org.forgerock.cuppa.transforms.ExpressionTagTestBlockFilter
Creates a new filter.

F

filterStackTrace(Throwable) - Static method in class org.forgerock.cuppa.ReporterSupport
Modify a Throwable's stacktrace by removing any stack elements that are not relevant to a test.
findHook(TestBlock, String) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Finds the first hook with the given description.
findTest(TestBlock, String) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Finds the first test with the given description.
findTestBlock(TestBlock, String) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Finds the first test block with the given description.
function - Variable in class org.forgerock.cuppa.model.Hook
A function to be executed (possibly more than once).
function - Variable in class org.forgerock.cuppa.model.Test
The body of the test.

G

get() - Method in class org.forgerock.cuppa.model.Option
Get the value of the option.
get(Class<O>) - Method in class org.forgerock.cuppa.model.Options
Get an option of the given type.
getDescription(TestBlock) - Static method in class org.forgerock.cuppa.ReporterSupport
Get a short human-readable description for the given test block.
getDescription(Hook) - Static method in class org.forgerock.cuppa.ReporterSupport
Get a short human-readable description for the given hook.
getFullDescription(TestBlock, List<TestBlock>) - Static method in class org.forgerock.cuppa.ReporterSupport
Get a full human-readable description for the given test block.
getFullDescription(Test, List<TestBlock>) - Static method in class org.forgerock.cuppa.ReporterSupport
Get a full human-readable description for the given test.
getFullDescription(Hook, List<TestBlock>) - Static method in class org.forgerock.cuppa.ReporterSupport
Get a full human-readable description for the given hook.
getRunOptions() - Method in class org.forgerock.cuppa.Configuration
Get the set of options that can be used by test block transforms.

H

hashCode() - Method in class org.forgerock.cuppa.model.Hook
 
hashCode() - Method in class org.forgerock.cuppa.model.Option
 
hashCode() - Method in class org.forgerock.cuppa.model.Options
 
hashCode() - Method in class org.forgerock.cuppa.model.Test
 
hashCode() - Method in class org.forgerock.cuppa.model.TestBlock
 
Hook - Class in org.forgerock.cuppa.model
Models a function that is executed before or after a test is run.
HookBuilder - Class in org.forgerock.cuppa.model
A mutable builder that constructs Hook instances.
HookBuilder() - Constructor for class org.forgerock.cuppa.model.HookBuilder
 
hookFail(Hook, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
hookFail(Hook, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
HookFunction - Interface in org.forgerock.cuppa.functions
Implement this interface to define a test hook.
hooks - Variable in class org.forgerock.cuppa.model.TestBlock
Hooks defined by the test block.
hooksOfType(HookType) - Method in class org.forgerock.cuppa.model.TestBlock
Get all the registered hooks of the given type, in the order they were defined.
HookType - Enum in org.forgerock.cuppa.model
Hook type.

I

identity() - Static method in interface org.forgerock.cuppa.functions.HookFunction
Returns a function that does nothing.
identity() - Static method in interface org.forgerock.cuppa.functions.TestFunction
Returns a function that does nothing.
instantiate(Class<?>) - Method in interface org.forgerock.cuppa.TestInstantiator
Instantiate a test class.
it(String, TestFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers a test function to be run.
it(String) - Static method in class org.forgerock.cuppa.Cuppa
Registers a pending test.
it(String, TestFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a test function to be run.
it(String) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a pending test.
it(Behaviour, String, Optional<TestFunction>, Options) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a test function to be run.
it(String, TestFunction) - Method in interface org.forgerock.cuppa.TestBuilder
Registers a test function to be run.
it(String) - Method in interface org.forgerock.cuppa.TestBuilder
Registers a pending test.

N

NotCondition - Class in org.forgerock.cuppa.transforms.expression
A wrapper condition that inverse the wrapped condition.

O

only() - Static method in class org.forgerock.cuppa.Cuppa
Mark a test or block of tests as the only tests that should be run.
only() - Method in enum org.forgerock.cuppa.internal.TestContainer
Mark a test or block of tests as the only tests that should be run.
only() - Method in interface org.forgerock.cuppa.TestBuilder
Mark a test or block of tests as the only tests that should be run.
OnlyTestBlockFilter - Class in org.forgerock.cuppa.internal.filters
Filters out all tests that are not marked as "only" if any test is marked as "only".
OnlyTestBlockFilter() - Constructor for class org.forgerock.cuppa.internal.filters.OnlyTestBlockFilter
 
Option<T> - Class in org.forgerock.cuppa.model
An option stores a value of the given type.
Option(T) - Constructor for class org.forgerock.cuppa.model.Option
Create a new option.
Options - Class in org.forgerock.cuppa.model
A set of options.
options - Variable in class org.forgerock.cuppa.model.Test
The set of options applied to the test.
options - Variable in class org.forgerock.cuppa.model.TestBlock
The set of options applied to the test block.
OrCondition - Class in org.forgerock.cuppa.transforms.expression
A condition that composes other conditions with a logical OR.
org.forgerock.cuppa - package org.forgerock.cuppa
A testing framework for Java 8.
org.forgerock.cuppa.functions - package org.forgerock.cuppa.functions
Functional interfaces for test definitions.
org.forgerock.cuppa.internal - package org.forgerock.cuppa.internal
Cuppa internals.
org.forgerock.cuppa.internal.filters - package org.forgerock.cuppa.internal.filters
Internal test block filters.
org.forgerock.cuppa.model - package org.forgerock.cuppa.model
Model for the structure of Cuppa tests.
org.forgerock.cuppa.reporters - package org.forgerock.cuppa.reporters
Reporters control the output of Cuppa.
org.forgerock.cuppa.transforms - package org.forgerock.cuppa.transforms
Test block filters.
org.forgerock.cuppa.transforms.expression - package org.forgerock.cuppa.transforms.expression
Classes related to the expression group filter.

P

parse(String) - Static method in class org.forgerock.cuppa.transforms.expression.ExpressionParser
Parse the expressionTags to a Condition.

R

registerTestTreeTransform(Function<TestBlock, TestBlock>) - Method in class org.forgerock.cuppa.Configuration
Register a transform.
removeCoreTestTransforms() - Method in class org.forgerock.cuppa.Configuration
Remove the test transforms that are defined by the core cuppa framework.
Reporter - Interface in org.forgerock.cuppa.reporters
A strategy for reporting on a suite of test runs.
ReporterSupport - Class in org.forgerock.cuppa
Provides utility methods for reporters.
run() - Method in class org.forgerock.cuppa.internal.TestBlockRunner
Runs all the tests in this test block and any nested test blocks.
run(TestBlock, Reporter) - Method in class org.forgerock.cuppa.Runner
Runs the tests contained in the provided test block and any nested test blocks, using the provided reporter.
Runner - Class in org.forgerock.cuppa
Runs Cuppa tests.
Runner() - Constructor for class org.forgerock.cuppa.Runner
Creates a new runner with no run tags and a configuration loaded from the classpath.
Runner(Tags) - Constructor for class org.forgerock.cuppa.Runner
Deprecated.
Use @{link Runner.Runner(Options)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.
Runner(Tags, Configuration) - Constructor for class org.forgerock.cuppa.Runner
Deprecated.
Use @{link Runner.Runner(Configuration)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.
Runner(Options) - Constructor for class org.forgerock.cuppa.Runner
Creates a new runner with the given run state and a configuration loaded from the classpath.
Runner(Configuration) - Constructor for class org.forgerock.cuppa.Runner
Creates a new runner with the given run state and configuration.
Runner.TagsRunOption - Class in org.forgerock.cuppa
Tag run state to perform tag based filtering with.
runTests(Runnable) - Method in enum org.forgerock.cuppa.internal.TestContainer
For internal use only.
runTests(TestBlock, Reporter) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Helper method to simplify running tests.
runTests(TestBlock, Reporter, Tags) - Static method in class org.forgerock.cuppa.TestCuppaSupport
Helper method to simplify running tests.

S

set(Option<T>) - Method in class org.forgerock.cuppa.model.Options
Set an option.
setAdditionalReporter(Reporter) - Method in class org.forgerock.cuppa.Configuration
Register a reporter that will be used in addition to the primary reporter given to the runner.
setBehaviour(Behaviour) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the behaviour of the test block.
setBehaviour(Behaviour) - Method in class org.forgerock.cuppa.model.TestBuilder
Sets the behaviour, which controls how the test behaves.
setDescription(Optional<String>) - Method in class org.forgerock.cuppa.model.HookBuilder
Sets the description of the hook.
setDescription(String) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the description of the test block.
setDescription(String) - Method in class org.forgerock.cuppa.model.TestBuilder
Sets the description of the test.
setFunction(HookFunction) - Method in class org.forgerock.cuppa.model.HookBuilder
Sets the function to be executed.
setFunction(Optional<TestFunction>) - Method in class org.forgerock.cuppa.model.TestBuilder
Sets the body of the test.
setHooks(List<Hook>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the hooks defined by the test block.
setOptions(Options) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the options applied to the test block.
setOptions(Options) - Method in class org.forgerock.cuppa.model.TestBuilder
Sets the options applied to the test.
setTestBlocks(List<TestBlock>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the nested test blocks.
setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.HookBuilder
Sets the class that the hook was defined in.
setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the class that the test block was defined in.
setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.TestBuilder
Sets the class that the test was defined in.
setTestInstantiator(TestInstantiator) - Method in class org.forgerock.cuppa.Configuration
Sets the class that will be used to instantiate test classes.
setTests(List<Test>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Sets the tests defined by the test block.
setType(HookType) - Method in class org.forgerock.cuppa.model.HookBuilder
Sets the type of the hook.
setType(TestBlockType) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
Set the type of the test block.
shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.AndCondition
 
shouldRun(Collection<String>) - Method in interface org.forgerock.cuppa.transforms.expression.Condition
Check if the list of tags is compliant with the condition.
shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.ContainsCondition
 
shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.NotCondition
 
shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.OrCondition
 
skip() - Static method in class org.forgerock.cuppa.Cuppa
Mark a test or block of tests to be skipped.
skip() - Method in enum org.forgerock.cuppa.internal.TestContainer
Mark a test or block of tests to be skipped.
skip() - Method in interface org.forgerock.cuppa.TestBuilder
Mark a test or block of tests to be skipped.
start(TestBlock) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
start(TestBlock) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
start(TestBlock) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called before any tests are run.

T

tags(String...) - Static method in class org.forgerock.cuppa.Cuppa
Decorates tests with a set of tags.
tags(String...) - Method in enum org.forgerock.cuppa.internal.TestContainer
Decorates tests with a set of tags.
Tags - Class in org.forgerock.cuppa.model
Encapsulates the tags to be used to filter which tests to be run as a part of the test run.
Tags(Set<String>, Set<String>, String) - Constructor for class org.forgerock.cuppa.model.Tags
Constructs a Tags instance with the specified tags and anti-tags (excluded tags).
tags - Variable in class org.forgerock.cuppa.model.Tags
The set of tags which tests must be tagged with to be included in the test run.
tags(Set<String>) - Static method in class org.forgerock.cuppa.model.Tags
Constructs a Tags instance with the specified tags.
TagsOption - Class in org.forgerock.cuppa.model
An option for tagging tests and test blocks.
TagsOption(Set<String>) - Constructor for class org.forgerock.cuppa.model.TagsOption
Create a new tags option.
TagsRunOption(Tags) - Constructor for class org.forgerock.cuppa.Runner.TagsRunOption
Create a new option.
TagTestBlockFilter - Class in org.forgerock.cuppa.transforms
Filters the test tree to only include tests that have tags that match the given run tags, excluding any tests that have the given excluded run tags.
TagTestBlockFilter(Tags) - Constructor for class org.forgerock.cuppa.transforms.TagTestBlockFilter
Creates a new filter.
Test - Class in org.forgerock.cuppa.model
Models a single test.
Test - Annotation Type in org.forgerock.cuppa
Identifies a class as containing Cuppa tests.
TestBlock - Class in org.forgerock.cuppa.model
Models a collection of tests and/or nested test blocks.
TestBlockBuilder - Class in org.forgerock.cuppa.model
A mutable builder that constructs TestBlock instances.
TestBlockBuilder() - Constructor for class org.forgerock.cuppa.model.TestBlockBuilder
 
testBlockEnd(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testBlockEnd(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testBlockEnd(TestBlock, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after all tests in a test block have completed.
TestBlockFunction - Interface in org.forgerock.cuppa.functions
Implement this interface to define tests within a describe or when block.
TestBlockRunner - Class in org.forgerock.cuppa.internal
Runs the tests within a test block.
TestBlockRunner(TestBlock, List<TestBlockRunner>, Reporter) - Constructor for class org.forgerock.cuppa.internal.TestBlockRunner
Constructs a new test block runner.
testBlocks - Variable in class org.forgerock.cuppa.model.TestBlock
Nested test blocks.
testBlockStart(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testBlockStart(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testBlockStart(TestBlock, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called before any tests are run in a test block.
TestBlockType - Enum in org.forgerock.cuppa.model
Models the type of a test block.
TestBuilder - Class in org.forgerock.cuppa.model
A mutable builder that constructs Test instances.
TestBuilder() - Constructor for class org.forgerock.cuppa.model.TestBuilder
 
TestBuilder - Interface in org.forgerock.cuppa
A builder for defining a test or block of tests.
testClass - Variable in class org.forgerock.cuppa.model.Hook
The class that the hook was defined in.
testClass - Variable in class org.forgerock.cuppa.model.Test
The class that the test was defined in.
testClass - Variable in class org.forgerock.cuppa.model.TestBlock
The class that the test block was defined in.
TestContainer - Enum in org.forgerock.cuppa.internal
Singleton container for user-defined tests.
TestCuppaSupport - Class in org.forgerock.cuppa
A collection of static methods for facilitating the writing of tests for Cuppa and its extensions (such as test block transforms).
testEnd(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testEnd(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after a test is run.
testFail(Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testFail(Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testFail(Test, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after a test has failed due to it throwing an exception.
TestFunction - Interface in org.forgerock.cuppa.functions
Implement this interface to define a test.
testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called when a beforeEach or afterEach hook failed due to it throwing an exception.
testHookPass(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testHookPass(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after a beforeEach or afterEach hook has successfully executed without throwing an exception.
testHookStart(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testHookStart(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called before a beforeEach or afterEach hook is run.
TestInstantiator - Interface in org.forgerock.cuppa
Instantiates test classes.
testPass(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testPass(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testPass(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called after a test has successfully executed without throwing an exception.
testPending(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testPending(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testPending(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called when a test cannot be run as it has not yet been implemented.
tests - Variable in class org.forgerock.cuppa.model.TestBlock
Tests defined by the test block.
testSkip(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testSkip(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
 
testSkip(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called when a test has been skipped.
testStart(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
 
testStart(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
Called before a test is run.
toBuilder() - Method in class org.forgerock.cuppa.model.Test
Creates a TestBuilder and initialises it's properties to this Test.
toBuilder() - Method in class org.forgerock.cuppa.model.TestBlock
Creates a TestBlockBuilder and initialises it's properties to this TestBlock.
toString() - Method in class org.forgerock.cuppa.model.Hook
 
toString() - Method in class org.forgerock.cuppa.model.Option
 
toString() - Method in class org.forgerock.cuppa.model.Options
 
toString() - Method in class org.forgerock.cuppa.model.Test
 
toString() - Method in class org.forgerock.cuppa.model.TestBlock
 
type - Variable in class org.forgerock.cuppa.model.Hook
The type of the hook.
type - Variable in class org.forgerock.cuppa.model.TestBlock
The type of the test block.

U

unset(Class<O>) - Method in class org.forgerock.cuppa.model.Options
Un-sets an option.

V

valueOf(String) - Static method in enum org.forgerock.cuppa.internal.TestContainer
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.cuppa.model.Behaviour
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.cuppa.model.HookType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.cuppa.model.TestBlockType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.forgerock.cuppa.internal.TestContainer
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.cuppa.model.Behaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.cuppa.model.HookType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.cuppa.model.TestBlockType
Returns an array containing the constants of this enum type, in the order they are declared.

W

when(String, TestBlockFunction) - Static method in class org.forgerock.cuppa.Cuppa
Registers a 'when' block of tests.
when(String, TestBlockFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
Registers a 'when' block to be run.
when(String, TestBlockFunction) - Method in interface org.forgerock.cuppa.TestBuilder
Registers a 'when' block to be run.
with(Option<?>...) - Static method in class org.forgerock.cuppa.Cuppa
Decorate a test or block of tests with additional options.
with(Option...) - Method in enum org.forgerock.cuppa.internal.TestContainer
Decorate a test or block of tests with additional options.
with(Option<?>...) - Method in interface org.forgerock.cuppa.TestBuilder
Decorate a test or block of tests with additional options.
A B C D E F G H I N O P R S T U V W 
Skip navigation links