MockApp.Builder (spals-appbuilder-app-mock 0.6.4 API)

java.lang.Object
- net.spals.appbuilder.app.mock.MockApp.Builder

All Implemented Interfaces:: WorkerAppBuilder<MockApp>

Enclosing class:: MockApp

public static class MockApp.Builder
extends Object
implements WorkerAppBuilder<MockApp>

Constructor Summary

Constructors
Constructor and Description

Builder(Class<?> testClazz)

Constructors
Constructor and Description
`Builder(Class<?> testClazz)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<I,M extends I> MockApp.Builder`	`addMockSingleton(M mockedService, Class<I> baseClass)`
`<I> MockApp.Builder`	`addMockSingleton(MockSingleton<I> mockSingleton)`
`MockApp.Builder`	`addModule(com.google.inject.Module module)`
`MockApp`	`build()` Returns a newly-created `MockApp` based on the contents of the `Builder`.
`MockApp`	`buildPartial()` Returns a newly-created partial `MockApp` for use in unit tests.
`MockApp.Builder`	`clear()` Resets the state of this builder.
`MockApp.Builder`	`disableErrorOnServiceLeaks()`
`MockApp.Builder`	`enableBindingOverrides()`
`MockApp.Builder`	`enableServiceGraph(net.spals.appbuilder.graph.model.ServiceGraphFormat graphFormat)`
`org.slf4j.Logger`	`getLogger()` Returns the value that will be returned by `App.getLogger()`.
`String`	`getName()` Returns the value that will be returned by `App.getName()`.
`com.typesafe.config.Config`	`getServiceConfig()` Returns the value that will be returned by `App.getServiceConfig()`.
`com.google.inject.Injector`	`getServiceInjector()` Returns the value that will be returned by `App.getServiceInjector()`.
`MockApp.Builder`	`mapLogger(java.util.function.UnaryOperator<org.slf4j.Logger> mapper)` Replaces the value to be returned by `App.getLogger()` by applying `mapper` to it and using the result.
`MockApp.Builder`	`mapName(java.util.function.UnaryOperator<String> mapper)` Replaces the value to be returned by `App.getName()` by applying `mapper` to it and using the result.
`MockApp.Builder`	`mapServiceConfig(java.util.function.UnaryOperator<com.typesafe.config.Config> mapper)` Replaces the value to be returned by `App.getServiceConfig()` by applying `mapper` to it and using the result.
`MockApp.Builder`	`mapServiceInjector(java.util.function.UnaryOperator<com.google.inject.Injector> mapper)` Replaces the value to be returned by `App.getServiceInjector()` by applying `mapper` to it and using the result.
`MockApp.Builder`	`mergeFrom(MockApp.Builder template)` Copies values from the given `Builder`.
`MockApp.Builder`	`mergeFrom(MockApp value)` Sets all property values using the given `MockApp` as a template.
`MockApp.Builder`	`setLogger(org.slf4j.Logger logger)` Sets the value to be returned by `App.getLogger()`.
`MockApp.Builder`	`setName(String name)` Sets the value to be returned by `App.getName()`.
`MockApp.Builder`	`setServiceConfig(com.typesafe.config.Config serviceConfig)` Sets the value to be returned by `App.getServiceConfig()`.
`MockApp.Builder`	`setServiceConfigFromClasspath(String serviceConfigFileName)`
`MockApp.Builder`	`setServiceInjector(com.google.inject.Injector serviceInjector)` Sets the value to be returned by `App.getServiceInjector()`.
`MockApp.Builder`	`setServiceScan(net.spals.appbuilder.config.service.ServiceScan serviceScan)`

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

- Constructor Detail
  - Builder
```
public Builder(Class<?> testClazz)
```
- Method Detail
  - addMockSingleton
```
public <I> MockApp.Builder addMockSingleton(MockSingleton<I> mockSingleton)
```
  - addMockSingleton
```
public <I,M extends I> MockApp.Builder addMockSingleton(M mockedService,
                                                        Class<I> baseClass)
```
  - addModule
```
public MockApp.Builder addModule(com.google.inject.Module module)
```
    Specified by:
    
    addModule in interface WorkerAppBuilder<MockApp>
  - disableErrorOnServiceLeaks
```
public MockApp.Builder disableErrorOnServiceLeaks()
```
    Specified by:
    
    disableErrorOnServiceLeaks in interface WorkerAppBuilder<MockApp>
  - enableBindingOverrides
```
public MockApp.Builder enableBindingOverrides()
```
    Specified by:
    
    enableBindingOverrides in interface WorkerAppBuilder<MockApp>
  - enableServiceGraph
```
public MockApp.Builder enableServiceGraph(net.spals.appbuilder.graph.model.ServiceGraphFormat graphFormat)
```
    Specified by:
    
    enableServiceGraph in interface WorkerAppBuilder<MockApp>
  - setServiceConfig
```
public MockApp.Builder setServiceConfig(com.typesafe.config.Config serviceConfig)
```
    Sets the value to be returned by App.getServiceConfig().
    
    Specified by:
    
    setServiceConfig in interface WorkerAppBuilder<MockApp>
    
    Returns:
    
    this Builder object
  - setServiceConfigFromClasspath
```
public MockApp.Builder setServiceConfigFromClasspath(String serviceConfigFileName)
```
    Specified by:
    
    setServiceConfigFromClasspath in interface WorkerAppBuilder<MockApp>
  - setServiceScan
```
public MockApp.Builder setServiceScan(net.spals.appbuilder.config.service.ServiceScan serviceScan)
```
    Specified by:
    
    setServiceScan in interface WorkerAppBuilder<MockApp>
  - build
```
public MockApp build()
```
    Returns a newly-created MockApp based on the contents of the Builder.
    
    Specified by:
    
    build in interface WorkerAppBuilder<MockApp>
  - setLogger
```
public MockApp.Builder setLogger(org.slf4j.Logger logger)
```
    Sets the value to be returned by App.getLogger().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if logger is null
  - mapLogger
```
public MockApp.Builder mapLogger(java.util.function.UnaryOperator<org.slf4j.Logger> mapper)
```
    Replaces the value to be returned by App.getLogger() by applying mapper to it and using the result.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if mapper is null or returns null
    
    IllegalStateException - if the field has not been set
  - getLogger
```
public org.slf4j.Logger getLogger()
```
    Returns the value that will be returned by App.getLogger().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setName
```
public MockApp.Builder setName(String name)
```
    Sets the value to be returned by App.getName().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if name is null
  - mapName
```
public MockApp.Builder mapName(java.util.function.UnaryOperator<String> mapper)
```
    Replaces the value to be returned by App.getName() by applying mapper to it and using the result.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if mapper is null or returns null
    
    IllegalStateException - if the field has not been set
  - getName
```
public String getName()
```
    Returns the value that will be returned by App.getName().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - mapServiceConfig
```
public MockApp.Builder mapServiceConfig(java.util.function.UnaryOperator<com.typesafe.config.Config> mapper)
```
    Replaces the value to be returned by App.getServiceConfig() by applying mapper to it and using the result.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if mapper is null or returns null
    
    IllegalStateException - if the field has not been set
  - getServiceConfig
```
public com.typesafe.config.Config getServiceConfig()
```
    Returns the value that will be returned by App.getServiceConfig().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setServiceInjector
```
public MockApp.Builder setServiceInjector(com.google.inject.Injector serviceInjector)
```
    Sets the value to be returned by App.getServiceInjector().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if serviceInjector is null
  - mapServiceInjector
```
public MockApp.Builder mapServiceInjector(java.util.function.UnaryOperator<com.google.inject.Injector> mapper)
```
    Replaces the value to be returned by App.getServiceInjector() by applying mapper to it and using the result.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if mapper is null or returns null
    
    IllegalStateException - if the field has not been set
  - getServiceInjector
```
public com.google.inject.Injector getServiceInjector()
```
    Returns the value that will be returned by App.getServiceInjector().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - mergeFrom
```
public MockApp.Builder mergeFrom(MockApp value)
```
    Sets all property values using the given MockApp as a template.
  - mergeFrom
```
public MockApp.Builder mergeFrom(MockApp.Builder template)
```
    Copies values from the given Builder. Does not affect any properties not set on the input.
  - clear
```
public MockApp.Builder clear()
```
    Resets the state of this builder.
  - buildPartial
```
public MockApp buildPartial()
```
    Returns a newly-created partial MockApp for use in unit tests. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.
    Partials should only ever be used in tests. They permit writing robust test cases that won't fail if this type gains more application-level constraints (e.g. new required fields) in future. If you require partially complete values in production code, consider using a Builder.

Class MockApp.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

addMockSingleton

addMockSingleton

addModule

disableErrorOnServiceLeaks

enableBindingOverrides

enableServiceGraph

setServiceConfig

setServiceConfigFromClasspath

setServiceScan

build

setLogger

mapLogger

getLogger

setName

mapName

getName

mapServiceConfig

getServiceConfig

setServiceInjector

mapServiceInjector

getServiceInjector

mergeFrom

mergeFrom

clear

buildPartial