AbstractApplicationBuilder (Speedment - Runtime

java.lang.Object
- com.speedment.runtime.application.AbstractApplicationBuilder<APP,BUILDER>

Type Parameters:

APP - the type that is being built

BUILDER - the (self) type of the AbstractApplicationBuilder

All Implemented Interfaces:

ApplicationBuilder<APP,BUILDER>
```
public abstract class AbstractApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
extends Object
implements ApplicationBuilder<APP,BUILDER>
```
This abstract class is implemented by classes that can build a Speedment application.

Since:

2.0.0

Author:

Per Minborg, Emil Forslund

Nested Class Summary
- Nested classes/interfaces inherited from interface com.speedment.runtime.core.ApplicationBuilder
  ApplicationBuilder.HasLoggerName, ApplicationBuilder.LogType

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractApplicationBuilder(Class<? extends APP> applicationImplClass, Class<? extends ApplicationMetadata> metadataClass)`
`protected`	`AbstractApplicationBuilder(ClassLoader classLoader, Class<? extends APP> applicationImplClass, Class<? extends ApplicationMetadata> metadataClass)`
`protected`	`AbstractApplicationBuilder(com.speedment.common.injector.InjectorBuilder injectorBuilder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`APP`	`build()` Builds this application.
`protected abstract APP`	`build(com.speedment.common.injector.Injector injector)` Builds the application using the specified injector.
`protected void`	`checkDatabaseConnectivity(com.speedment.common.injector.Injector injector)`
`protected void`	`printWelcomeMessage(com.speedment.common.injector.Injector injector)` Prints a welcome message to the output channel.
`protected void`	`validateRuntimeConfig(com.speedment.common.injector.Injector injector)`
`<C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER`	`with(Class<C> type, BiConsumer<com.speedment.common.injector.Injector,C> consumer)` Configures a parameter for all `Document` of a certain class.
`<C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER`	`with(Class<C> type, Consumer<C> consumer)` Configures a parameter for all `Document` of a certain class.
`<C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER`	`with(Class<C> type, String name, BiConsumer<com.speedment.common.injector.Injector,C> consumer)` Configures a parameter for the named `Document` of a certain class.
`BUILDER`	`withAllowStreamIteratorAndSpliterator()` Allows `BaseStream.iterator()` and `BaseStream.spliterator()` terminating operations to be called on Speedment streams.
`BUILDER`	`withBundle(Class<? extends com.speedment.common.injector.InjectBundle> bundleClass)` Adds a custom bundle of dependency injectable implementation classes.
`BUILDER`	`withComponent(Class<?> injectableClass)` Adds a custom component implementation class.
`<T> BUILDER`	`withComponent(Class<T> injectableClass, Supplier<T> supplier)`
`BUILDER`	`withConnectionUrl(String connectionUrl)` Configures a connection URL for all dbmses in this project.
`BUILDER`	`withConnectionUrl(String dbmsName, String connectionUrl)` Configures a connection URL for the named dbms in this project.
`BUILDER`	`withIpAddress(String ipAddress)` Configures an IP-address for all dbmses in this project.
`BUILDER`	`withIpAddress(String dbmsName, String ipAddress)` Configures an IP-address for the named dbms.
`BUILDER`	`withLogging(ApplicationBuilder.HasLoggerName namer)` Adds a logging configuration to the application.
`<M extends Manager<?>> BUILDER`	`withManager(Class<M> managerImplType)` Adds a custom manager.
`BUILDER`	`withParam(String key, String value)` Sets a config parameter that will be set automatically in all instances created during initialization.
`BUILDER`	`withPassword(char[] password)` Configures a password for all dbmses in this project.
`BUILDER`	`withPassword(String password)` Configures a password for all dbmses in this project.
`BUILDER`	`withPassword(String dbmsName, char[] password)` Configures a password for the named dbms.
`BUILDER`	`withPassword(String dbmsName, String password)` Configures a password for the named dbms.
`BUILDER`	`withPort(int port)` Configures a port for all dbmses in this project.
`BUILDER`	`withPort(String dbmsName, int port)` Configures a port for the named dbms.
`BUILDER`	`withSchema(String schemaName)` Configures a new schema name for all schemas in this project.
`BUILDER`	`withSchema(String oldSchemaName, String schemaName)` Configures a new schema name for the named old schema name.
`BUILDER`	`withSkipCheckDatabaseConnectivity()` Sets that the initial database check shall be skipped upon build().
`BUILDER`	`withSkipLogoPrintout()` Sets that the logo printout shall be skipped upon build().
`BUILDER`	`withSkipValidateRuntimeConfig()` Sets that the initial validation of the configuration shall be skipped upon build().
`BUILDER`	`withUsername(String username)` Configures a username for all dbmses in this project.
`BUILDER`	`withUsername(String dbmsName, String username)` Configures a username for the named dbms.

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

Methods inherited from interface com.speedment.runtime.core.ApplicationBuilder
with, withColumn, withColumn, withConnectionUrl, withDbms, withDbms, withIpAddress, withPassword, withPassword, withPort, withSchema, withSchema, withTable, withTable, withUsername

- Constructor Detail
  - AbstractApplicationBuilder
```
protected AbstractApplicationBuilder(Class<? extends APP> applicationImplClass,
                                     Class<? extends ApplicationMetadata> metadataClass)
```
  - AbstractApplicationBuilder
```
protected AbstractApplicationBuilder(ClassLoader classLoader,
                                     Class<? extends APP> applicationImplClass,
                                     Class<? extends ApplicationMetadata> metadataClass)
```
  - AbstractApplicationBuilder
```
protected AbstractApplicationBuilder(com.speedment.common.injector.InjectorBuilder injectorBuilder)
```
- Method Detail
  - with
```
public <C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER with(Class<C> type,
                                                                                                                      String name,
                                                                                                                      BiConsumer<com.speedment.common.injector.Injector,C> consumer)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a parameter for the named Document of a certain class. The consumer will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    with in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Type Parameters:
    
    C - the type of Document that is to be used
    
    Parameters:
    
    type - the class of the type of Document that is to be used
    
    name - the fully qualified name of the Document.
    
    consumer - the consumer to apply
    
    Returns:
    
    this instance
  - with
```
public <C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER with(Class<C> type,
                                                                                                                      BiConsumer<com.speedment.common.injector.Injector,C> consumer)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a parameter for all Document of a certain class. The consumer will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    with in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Type Parameters:
    
    C - the type of Document that is to be used
    
    Parameters:
    
    type - the class of the type of Document that is to be used
    
    consumer - the consumer to apply
    
    Returns:
    
    this instance
  - with
```
public <C extends com.speedment.runtime.config.Document & com.speedment.runtime.config.trait.HasEnabled> BUILDER with(Class<C> type,
                                                                                                                      Consumer<C> consumer)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a parameter for all Document of a certain class. The consumer will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    with in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Type Parameters:
    
    C - the type of Document that is to be used
    
    Parameters:
    
    type - the class of the type of Document that is to be used
    
    consumer - the consumer to apply
    
    Returns:
    
    this instance
  - withParam
```
public BUILDER withParam(String key,
                         String value)
```
    Description copied from interface: ApplicationBuilder
    
    Sets a config parameter that will be set automatically in all instances created during initialization. This parameter can override settings in the settings file.
    
    Specified by:
    
    withParam in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    key - the key to set
    
    value - the new value
    
    Returns:
    
    this instance
  - withPassword
```
public BUILDER withPassword(char[] password)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a password for all dbmses in this project. The password will then be applied after the configuration has been read and after the System properties have been applied.
    This will not be saved in any configuration files!
    
    Specified by:
    
    withPassword in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    password - to use for all dbms:es in this project
    
    Returns:
    
    this instance
  - withPassword
```
public BUILDER withPassword(String dbmsName,
                            char[] password)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a password for the named dbms. The password will then be applied after the configuration has been read and after the System properties have been applied.
    This will not be saved in any configuration files!
    
    Specified by:
    
    withPassword in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    password - to use for the named dbms
    
    Returns:
    
    this instance
  - withPassword
```
public BUILDER withPassword(String password)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a password for all dbmses in this project. The password will then be applied after the configuration has been read and after the System properties have been applied.
    This will not be saved in any configuration files!
    
    Specified by:
    
    withPassword in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    password - to use for all dbms:es in this project
    
    Returns:
    
    this instance
  - withPassword
```
public BUILDER withPassword(String dbmsName,
                            String password)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a password for the named dbms. The password will then be applied after the configuration has been read and after the System properties have been applied.
    This will not be saved in any configuration files!
    
    Specified by:
    
    withPassword in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    password - to use for the named dbms
    
    Returns:
    
    this instance
  - withUsername
```
public BUILDER withUsername(String username)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a username for all dbmses in this project. The username will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withUsername in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    username - to use for all dbms:es in this project
    
    Returns:
    
    this instance
  - withUsername
```
public BUILDER withUsername(String dbmsName,
                            String username)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a username for the named dbms. The username will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withUsername in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    username - to use for the named dbms
    
    Returns:
    
    this instance
  - withIpAddress
```
public BUILDER withIpAddress(String ipAddress)
```
    Description copied from interface: ApplicationBuilder
    
    Configures an IP-address for all dbmses in this project. The IP-address will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withIpAddress in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    ipAddress - to use for all dbms:es in this project
    
    Returns:
    
    this instance
  - withIpAddress
```
public BUILDER withIpAddress(String dbmsName,
                             String ipAddress)
```
    Description copied from interface: ApplicationBuilder
    
    Configures an IP-address for the named dbms. The IP-address will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withIpAddress in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    ipAddress - to use for the named dbms.
    
    Returns:
    
    this instance
  - withPort
```
public BUILDER withPort(int port)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a port for all dbmses in this project. The port will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withPort in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    port - to use for all dbms:es in this project
    
    Returns:
    
    this instance
  - withPort
```
public BUILDER withPort(String dbmsName,
                        int port)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a port for the named dbms. The port will then be applied after the configuration has been read and after the System properties have been applied.
    
    Specified by:
    
    withPort in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    port - to use for the named dbms
    
    Returns:
    
    this instance
  - withSchema
```
public BUILDER withSchema(String schemaName)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a new schema name for all schemas in this project. The new schema name will then be applied after the configuration has been read and after the System properties have been applied.
    This method is useful for multi-tenant projects where there are several identical schemas separated only by their names.
    
    Specified by:
    
    withSchema in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    schemaName - to use for all schemas this project
    
    Returns:
    
    this instance
  - withSchema
```
public BUILDER withSchema(String oldSchemaName,
                          String schemaName)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a new schema name for the named old schema name. The new schema name will then be applied after the configuration has been read and after the System properties have been applied.
    This method is useful for multi-tenant projects where there are several identical schemas separated only by their names.
    
    Specified by:
    
    withSchema in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    oldSchemaName - the current name of a schema
    
    schemaName - to use for the named schema
    
    Returns:
    
    this instance
  - withConnectionUrl
```
public BUILDER withConnectionUrl(String connectionUrl)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a connection URL for all dbmses in this project. The new connection URL will then be applied after the configuration has been read and after the System properties have been applied. If the connectionUrl is set to null, the connection URL will be calculated using the dbmses' default connection URL generator (e.g. using ipAddress, port, etc).
    
    Specified by:
    
    withConnectionUrl in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    connectionUrl - to use for all dbms this project or null
    
    Returns:
    
    this instance
  - withConnectionUrl
```
public BUILDER withConnectionUrl(String dbmsName,
                                 String connectionUrl)
```
    Description copied from interface: ApplicationBuilder
    
    Configures a connection URL for the named dbms in this project. The new connection URL will then be applied after the configuration has been read and after the System properties have been applied. If the connectionUrl is set to null, the connection URL will be calculated using the dbmses' default connection URL generator (e.g. using ipAddress, port, etc).
    
    Specified by:
    
    withConnectionUrl in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    dbmsName - the name of the dbms
    
    connectionUrl - to use for the named dbms or null
    
    Returns:
    
    this instance
  - withManager
```
public <M extends Manager<?>> BUILDER withManager(Class<M> managerImplType)
```
    Description copied from interface: ApplicationBuilder
    
    Adds a custom manager.
    
    Specified by:
    
    withManager in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Type Parameters:
    
    M - the manager type
    
    Parameters:
    
    managerImplType - the manager implementation class
    
    Returns:
    
    this instance
  - withSkipCheckDatabaseConnectivity
```
public BUILDER withSkipCheckDatabaseConnectivity()
```
    Description copied from interface: ApplicationBuilder
    
    Sets that the initial database check shall be skipped upon build().
    
    Specified by:
    
    withSkipCheckDatabaseConnectivity in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Returns:
    
    this instance
  - withSkipValidateRuntimeConfig
```
public BUILDER withSkipValidateRuntimeConfig()
```
    Description copied from interface: ApplicationBuilder
    
    Sets that the initial validation of the configuration shall be skipped upon build(). Useful for testing.
    
    Specified by:
    
    withSkipValidateRuntimeConfig in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Returns:
    
    this instance
  - withSkipLogoPrintout
```
public BUILDER withSkipLogoPrintout()
```
    Description copied from interface: ApplicationBuilder
    
    Sets that the logo printout shall be skipped upon build().
    
    Specified by:
    
    withSkipLogoPrintout in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Returns:
    
    this instance
  - withBundle
```
public BUILDER withBundle(Class<? extends com.speedment.common.injector.InjectBundle> bundleClass)
```
    Description copied from interface: ApplicationBuilder
    
    Adds a custom bundle of dependency injectable implementation classes.
    The specified classes will be instantiated using its default constructor and fields annotated with Inject will be dependency injected. Methods annotated with ExecuteBefore will also be executed as part of the application configuration phase.
    Note: If a class in the InjectBundle is specifying the same InjectKey as an existing class previously added to this ApplicationBuilder, then the last class will be associated with that InjectKey. Thus, the order of calls to this method is significant.
    
    Specified by:
    
    withBundle in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    bundleClass - to use when adding injectables
    
    Returns:
    
    this instance
  - withComponent
```
public BUILDER withComponent(Class<?> injectableClass)
```
    Description copied from interface: ApplicationBuilder
    
    Adds a custom component implementation class. The specified class will be instantiated using its default constructor and fields annotated with Inject will be dependency injected. Methods annotated with ExecuteBefore will also be executed as part of the application configuration phase.
    Note: If a component class is specifying the same InjectKey as an existing class previously added to this ApplicationBuilder, then the last class will be associated with that InjectKey. Thus, the order of calls to ApplicationBuilder.withComponent(java.lang.Class) and ApplicationBuilder.withBundle(java.lang.Class) is significant.
    
    Specified by:
    
    withComponent in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    injectableClass - the implementation class
    
    Returns:
    
    this instance
  - withComponent
```
public <T> BUILDER withComponent(Class<T> injectableClass,
                                 Supplier<T> supplier)
```
  - withLogging
```
public BUILDER withLogging(ApplicationBuilder.HasLoggerName namer)
```
    Description copied from interface: ApplicationBuilder
    
    Adds a logging configuration to the application. A number of standard log types are available in the class LogType.
    
    Specified by:
    
    withLogging in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Parameters:
    
    namer - logger with the namer to turn on
    
    Returns:
    
    this instance
    
    See Also:
    
    for standard implementation
  - withAllowStreamIteratorAndSpliterator
```
public BUILDER withAllowStreamIteratorAndSpliterator()
```
    Description copied from interface: ApplicationBuilder
    
    Allows BaseStream.iterator() and BaseStream.spliterator() terminating operations to be called on Speedment streams.
    Note: if enabled, make sure to close the Stream or else database connections will be consumed.
    try (Stream<User> userStream = users.stream()) { Iterator<User> userIterator = userStream(); // Do something with the Iterator } // The stream is auto-closed and the connection (if any) is returned.
    
    Specified by:
    
    withAllowStreamIteratorAndSpliterator in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Returns:
    
    this instance
  - build
```
public final APP build()
```
    Description copied from interface: ApplicationBuilder
    
    Builds this application. This is expected to be the last method called on this object.
    
    Specified by:
    
    build in interface ApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>
    
    Returns:
    
    the built application
  - build
```
protected abstract APP build(com.speedment.common.injector.Injector injector)
```
    Builds the application using the specified injector.
    
    Parameters:
    
    injector - the injector to use
    
    Returns:
    
    the built instance.
  - validateRuntimeConfig
```
protected void validateRuntimeConfig(com.speedment.common.injector.Injector injector)
```
  - checkDatabaseConnectivity
```
protected void checkDatabaseConnectivity(com.speedment.common.injector.Injector injector)
```
  - printWelcomeMessage
```
protected void printWelcomeMessage(com.speedment.common.injector.Injector injector)
```
    Prints a welcome message to the output channel.
    
    Parameters:
    
    injector - the injector to use

Class AbstractApplicationBuilder<APP extends Speedment,BUILDER extends AbstractApplicationBuilder<APP,BUILDER>>

Nested Class Summary

Nested classes/interfaces inherited from interface com.speedment.runtime.core.ApplicationBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.speedment.runtime.core.ApplicationBuilder

Constructor Detail

AbstractApplicationBuilder

AbstractApplicationBuilder

AbstractApplicationBuilder

Method Detail

with

with

with

withParam

withPassword

withPassword

withPassword

withPassword

withUsername

withUsername

withIpAddress

withIpAddress

withPort

withPort

withSchema

withSchema

withConnectionUrl

withConnectionUrl

withManager

withSkipCheckDatabaseConnectivity

withSkipValidateRuntimeConfig

withSkipLogoPrintout

withBundle

withComponent

withComponent

withLogging

withAllowStreamIteratorAndSpliterator

build

build

validateRuntimeConfig

checkDatabaseConnectivity

printWelcomeMessage