AbstractWhenThen (core 1.0.0-beta1 API)

java.lang.Object
- fi.vincit.multiusertest.rule.expectation.AbstractWhenThen<T>

All Implemented Interfaces:

Then<T>, ThenProducer<T>, When<T>, WhenProducer<T>, WhenThen<T>

Direct Known Subclasses:

FunctionCallWhenThen, ReturnValueWhenThen
```
public abstract class AbstractWhenThen<T extends TestExpectation>
extends java.lang.Object
implements WhenThen<T>
```

Constructor Summary

Constructors
Constructor and Description
`AbstractWhenThen(UserIdentifier producerIdentifier, UserIdentifier userIdentifier, Authorization authorizationRule, UserRoleIT userRoleIT)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`WhenThen<T>`	`byDefault(T testExpectation)` Define default expectation.
`WhenThen<T>`	`debugRoleMappings(java.util.function.Consumer<java.lang.String> logger)` Prints role mappings using the given consumer to print them
`protected abstract T`	`getDefaultExpectation(ConsumerProducerSet consumerProducerSet)`
`WhenThen<T>`	`otherwise(T testExpectation)` Define default expectation.
`void`	`test()` Execute the call under test and run assertions
`protected abstract void`	`test(T testExpectation, ConsumerProducerSet consumerProducerSet)`
`WhenThen<T>`	`then(T testExpectation)` Make sure to call `When.whenCalledWithAnyOf(fi.vincit.multiusertest.util.UserIdentifierCollection...)` or `When.whenCalledWithAnyOf(UserIdentifier...)` first to set the user identifiers this call will add the expectation.
`ThenProducer<T>`	`whenCalledWithAnyOf(java.util.Collection<UserIdentifier> userIdentifiers)` Sets the active consumers for assertions.
`ThenProducer<T>`	`whenCalledWithAnyOf(java.util.function.Supplier<java.util.Collection<UserIdentifier>> userIdentifierSupplier)` Sets the active consumers for assertions.
`ThenProducer<T>`	`whenCalledWithAnyOf(UserIdentifier... userIdentifiers)` Sets the active consumers for assertions.
`ThenProducer<T>`	`whenCalledWithAnyOf(UserIdentifierCollection... userIdentifiers)` Sets the active consumers for assertions.
`When<T>`	`whenProducerIsAny()` Sets the active producer to be any.
`When<T>`	`whenProducerIsAnyOf(java.util.Collection<UserIdentifier> producerIdentifiers)` Sets the active producers for assertions.
`When<T>`	`whenProducerIsAnyOf(java.util.function.Supplier<java.util.Collection<UserIdentifier>> producerIdentifierSupplier)` Sets the active producers for assertions.
`When<T>`	`whenProducerIsAnyOf(UserIdentifier... producerIdentifiers)` Sets the active producers for assertions.
`When<T>`	`whenProducerIsAnyOf(UserIdentifierCollection... producerIdentifiers)` Sets the active producers for assertions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractWhenThen
```
public AbstractWhenThen(UserIdentifier producerIdentifier,
                        UserIdentifier userIdentifier,
                        Authorization authorizationRule,
                        UserRoleIT userRoleIT)
```
- Method Detail
  - whenCalledWithAnyOf
```
public ThenProducer<T> whenCalledWithAnyOf(UserIdentifierCollection... userIdentifiers)
```
    Description copied from interface: When
    
    Sets the active consumers for assertions. Called by using methods found in UserIdentifiers.
    
    Specified by:
    
    whenCalledWithAnyOf in interface When<T extends TestExpectation>
    
    Parameters:
    
    userIdentifiers - User identifier collections
    
    Returns:
    
    Expectation API object
  - whenCalledWithAnyOf
```
public ThenProducer<T> whenCalledWithAnyOf(UserIdentifier... userIdentifiers)
```
    Description copied from interface: When
    
    Sets the active consumers for assertions. Called with zero or more UserIdentifier objects. In most cases When.whenCalledWithAnyOf(UserIdentifierCollection...) is preferred since it works well with UserIdentifiers helper methods.
    
    Specified by:
    
    whenCalledWithAnyOf in interface When<T extends TestExpectation>
    
    Parameters:
    
    userIdentifiers - User identifiers
    
    Returns:
    
    Expectation API object
  - whenCalledWithAnyOf
```
public ThenProducer<T> whenCalledWithAnyOf(java.util.Collection<UserIdentifier> userIdentifiers)
```
    Description copied from interface: When
    
    Sets the active consumers for assertions. Called with a list of UserIdentifier objects.
    
    Specified by:
    
    whenCalledWithAnyOf in interface When<T extends TestExpectation>
    
    Parameters:
    
    userIdentifiers - Collection of user identifiers
    
    Returns:
    
    Expectation API object
  - whenCalledWithAnyOf
```
public ThenProducer<T> whenCalledWithAnyOf(java.util.function.Supplier<java.util.Collection<UserIdentifier>> userIdentifierSupplier)
```
    Description copied from interface: When
    
    Sets the active consumers for assertions. Called with a supplier method that returns a collection of identifiers. Calling this will clear active producer identifiers.
    
    Specified by:
    
    whenCalledWithAnyOf in interface When<T extends TestExpectation>
    
    Parameters:
    
    userIdentifierSupplier - Supplier method
    
    Returns:
    
    Expectation API object
  - whenProducerIsAny
```
public When<T> whenProducerIsAny()
```
    Description copied from interface: WhenProducer
    
    Sets the active producer to be any. Calling this will clear active consumer identifiers.
    
    Specified by:
    
    whenProducerIsAny in interface WhenProducer<T extends TestExpectation>
    
    Returns:
    
    Expectation API object
  - whenProducerIsAnyOf
```
public When<T> whenProducerIsAnyOf(UserIdentifierCollection... producerIdentifiers)
```
    Description copied from interface: WhenProducer
    
    Sets the active producers for assertions. Called by using methods found in UserIdentifiers. Calling this will clear active consumer identifiers.
    
    Specified by:
    
    whenProducerIsAnyOf in interface WhenProducer<T extends TestExpectation>
    
    Parameters:
    
    producerIdentifiers - Producer identifier collections
    
    Returns:
    
    Expectation API object
  - whenProducerIsAnyOf
```
public When<T> whenProducerIsAnyOf(UserIdentifier... producerIdentifiers)
```
    Description copied from interface: WhenProducer
    
    Sets the active producers for assertions. Called with zero or more UserIdentifier objects. In most cases WhenProducer.whenProducerIsAnyOf(UserIdentifierCollection...) is preferred since it works well with UserIdentifiers helper methods. Calling this will clear active consumer identifiers.
    
    Specified by:
    
    whenProducerIsAnyOf in interface WhenProducer<T extends TestExpectation>
    
    Parameters:
    
    producerIdentifiers - User identifiers
    
    Returns:
    
    Expectation API object
  - whenProducerIsAnyOf
```
public When<T> whenProducerIsAnyOf(java.util.Collection<UserIdentifier> producerIdentifiers)
```
    Description copied from interface: WhenProducer
    
    Sets the active producers for assertions. Called with a list of UserIdentifier objects. Calling this will clear active consumer identifiers.
    
    Specified by:
    
    whenProducerIsAnyOf in interface WhenProducer<T extends TestExpectation>
    
    Parameters:
    
    producerIdentifiers - Collection of user identifiers
    
    Returns:
    
    Expectation API object
  - whenProducerIsAnyOf
```
public When<T> whenProducerIsAnyOf(java.util.function.Supplier<java.util.Collection<UserIdentifier>> producerIdentifierSupplier)
```
    Description copied from interface: WhenProducer
    
    Sets the active producers for assertions. Called with a supplier method that returns a collection of identifiers
    
    Specified by:
    
    whenProducerIsAnyOf in interface WhenProducer<T extends TestExpectation>
    
    Parameters:
    
    producerIdentifierSupplier - Supplier method
    
    Returns:
    
    Expectation API object
  - then
```
public WhenThen<T> then(T testExpectation)
```
    Description copied from interface: Then
    
    Make sure to call When.whenCalledWithAnyOf(fi.vincit.multiusertest.util.UserIdentifierCollection...) or When.whenCalledWithAnyOf(UserIdentifier...) first to set the user identifiers this call will add the expectation.
    
    Specified by:
    
    then in interface Then<T extends TestExpectation>
    
    Parameters:
    
    testExpectation - Expectation to test for the previous when identifiers
    
    Returns:
    
    Expectation API object
  - otherwise
```
public WhenThen<T> otherwise(T testExpectation)
```
    Description copied from interface: Then
    
    Define default expectation.
    
    Specified by:
    
    otherwise in interface Then<T extends TestExpectation>
    
    Parameters:
    
    testExpectation - Default expectation
    
    Returns:
    
    Expectation API object
  - byDefault
```
public WhenThen<T> byDefault(T testExpectation)
```
    Description copied from interface: Then
    
    Define default expectation. Alias for Then.otherwise(TestExpectation).
    
    Specified by:
    
    byDefault in interface Then<T extends TestExpectation>
    
    Parameters:
    
    testExpectation - Default expectation
    
    Returns:
    
    Expectation API object
  - debugRoleMappings
```
public WhenThen<T> debugRoleMappings(java.util.function.Consumer<java.lang.String> logger)
```
    Description copied from interface: WhenThen
    
    Prints role mappings using the given consumer to print them
    
    Specified by:
    
    debugRoleMappings in interface WhenThen<T extends TestExpectation>
    
    Parameters:
    
    logger - Logger printer
    
    Returns:
    
    Expectation API object
  - test
```
public void test()
          throws java.lang.Throwable
```
    Description copied from interface: WhenThen
    
    Execute the call under test and run assertions
    
    Specified by:
    
    test in interface WhenThen<T extends TestExpectation>
    
    Throws:
    
    java.lang.Throwable - If an exception is thrown during the test
  - test
```
protected abstract void test(T testExpectation,
                             ConsumerProducerSet consumerProducerSet)
                      throws java.lang.Throwable
```
    Throws:
    
    java.lang.Throwable
  - getDefaultExpectation
```
protected abstract T getDefaultExpectation(ConsumerProducerSet consumerProducerSet)
```

Class AbstractWhenThen<T extends TestExpectation>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractWhenThen

Method Detail

whenCalledWithAnyOf

whenCalledWithAnyOf

whenCalledWithAnyOf

whenCalledWithAnyOf

whenProducerIsAny

whenProducerIsAnyOf

whenProducerIsAnyOf

whenProducerIsAnyOf

whenProducerIsAnyOf

then

otherwise

byDefault

debugRoleMappings

test

test

getDefaultExpectation