com.speedment.runtime.core

Interface ApplicationBuilder<APP extends Speedment,BUILDER extends ApplicationBuilder<APP,BUILDER>>

Type Parameters:

APP - application that is built

BUILDER - the type of this builder

All Known Implementing Classes:

AbstractApplicationBuilder

public interface ApplicationBuilder<APP extends Speedment,BUILDER extends ApplicationBuilder<APP,BUILDER>>

Builder class for producing new Speedment instances.

Since:

3.0.0

Author:

Emil Forslund

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ApplicationBuilder.HasLoggerName Interface used for getting logger names.
static class	ApplicationBuilder.LogType The type of logging to change the settings for.

Method Summary

Modifier and Type	Method and Description
APP	build() Builds this application.
<C extends Document & 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 Document & HasEnabled> BUILDER	with(Class<C> type, Consumer<C> consumer) Configures a parameter for all Document of a certain class.
<C extends Document & 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.
default <C extends Document & HasEnabled> BUILDER	with(Class<C> type, String name, Consumer<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.
default <I extends HasDbmsId & HasSchemaId & HasTableId & HasColumnId> BUILDER	withColumn(I id, BiConsumer<com.speedment.common.injector.Injector,Column> consumer) Configures a parameter for the identified column.
default <I extends HasDbmsId & HasSchemaId & HasTableId & HasColumnId> BUILDER	withColumn(I id, Consumer<Column> consumer) Configures a parameter for the identified table.
BUILDER	withComponent(Class<?> componentClass) Adds a custom component implementation class.
default <I extends HasDbmsId> BUILDER	withConnectionUrl(I id, String connectionUrl) Configures a connection URL for the identified dbms.
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.
default <I extends HasDbmsId> BUILDER	withDbms(I identifier, BiConsumer<com.speedment.common.injector.Injector,Dbms> consumer) Configures a parameter for the identified dbms.
default <I extends HasDbmsId> BUILDER	withDbms(I id, Consumer<Dbms> consumer) Configures a parameter for the identified dbms.
default <I extends HasDbmsId> BUILDER	withIpAddress(I id, String ipAddress) Configures an IP Address for the identified dbms.
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.
default <I extends HasDbmsId> BUILDER	withPassword(I id, char[] password) Configures a password for the identified dbms.
default <I extends HasDbmsId> BUILDER	withPassword(I id, String password) Configures a password for the identified dbms.
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.
default <I extends HasDbmsId> BUILDER	withPort(I id, int port) Configures a port for the identified 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.
default <I extends HasDbmsId & HasSchemaId> BUILDER	withSchema(I identifier, BiConsumer<com.speedment.common.injector.Injector,Schema> consumer) Configures a parameter for the identified schema.
default <I extends HasDbmsId & HasSchemaId> BUILDER	withSchema(I id, Consumer<Schema> consumer) Configures a parameter for the identified schema.
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().
default <I extends HasDbmsId & HasSchemaId & HasTableId> BUILDER	withTable(I identifier, BiConsumer<com.speedment.common.injector.Injector,Table> consumer) Configures a parameter for the identified table.
default <I extends HasDbmsId & HasSchemaId & HasTableId> BUILDER	withTable(I id, Consumer<Table> consumer) Configures a parameter for the identified table.
default <I extends HasDbmsId> BUILDER	withUsername(I id, String username) Configures a username for the identified dbms.
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.

Method Detail

withDbms

default <I extends HasDbmsId> BUILDER withDbms(I id,
                                               Consumer<Dbms> consumer)

Configures a parameter for the identified dbms. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

id - of the dbms

consumer - the consumer to apply

Returns:

this instance

withDbms

default <I extends HasDbmsId> BUILDER withDbms(I identifier,
                                               BiConsumer<com.speedment.common.injector.Injector,Dbms> consumer)

Configures a parameter for the identified dbms. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

identifier - of the dbms

consumer - the consumer to apply

Returns:

this instance

withSchema

default <I extends HasDbmsId & HasSchemaId> BUILDER withSchema(I id,
                                                               Consumer<Schema> consumer)

Configures a parameter for the identified schema. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

id - of the schema

consumer - the consumer to apply

Returns:

this instance

withSchema

default <I extends HasDbmsId & HasSchemaId> BUILDER withSchema(I identifier,
                                                               BiConsumer<com.speedment.common.injector.Injector,Schema> consumer)

Configures a parameter for the identified schema. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

identifier - of the schema

consumer - the consumer to apply

Returns:

this instance

withTable

default <I extends HasDbmsId & HasSchemaId & HasTableId> BUILDER withTable(I id,
                                                                           Consumer<Table> consumer)

Configures a parameter for the identified table. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

id - of the table

consumer - the consumer to apply

Returns:

this instance

withTable

default <I extends HasDbmsId & HasSchemaId & HasTableId> BUILDER withTable(I identifier,
                                                                           BiConsumer<com.speedment.common.injector.Injector,Table> consumer)

Configures a parameter for the identified table. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

identifier - of the table

consumer - the consumer to apply

Returns:

this instance

withColumn

default <I extends HasDbmsId & HasSchemaId & HasTableId & HasColumnId> BUILDER withColumn(I id,
                                                                                          Consumer<Column> consumer)

Configures a parameter for the identified table. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

id - of the column

consumer - the consumer to apply

Returns:

this instance

withColumn

default <I extends HasDbmsId & HasSchemaId & HasTableId & HasColumnId> BUILDER withColumn(I id,
                                                                                          BiConsumer<com.speedment.common.injector.Injector,Column> consumer)

Configures a parameter for the identified column. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

Type Parameters:

I - the identifier type

Parameters:

id - of the column

consumer - the consumer to apply

Returns:

this instance

with

default <C extends Document & HasEnabled> BUILDER with(Class<C> type,
                                                       String name,
                                                       Consumer<C> consumer)

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.

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

<C extends Document & 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. The consumer will then be applied after the configuration has been read and after the System properties have been applied.

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

<C extends Document & HasEnabled> BUILDER with(Class<C> type,
                                               Consumer<C> consumer)

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.

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

<C extends Document & HasEnabled> BUILDER with(Class<C> type,
                                               BiConsumer<com.speedment.common.injector.Injector,C> consumer)

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.

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

BUILDER withParam(String key,
                  String value)

Sets a config parameter that will be set automatically in all instances created during initialization. This parameter can override settings in the settings file.

Parameters:

key - the key to set

value - the new value

Returns:

this instance

withPassword

BUILDER withPassword(char[] password)

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!

Parameters:

password - to use for all dbms:es in this project

Returns:

this instance

withPassword

BUILDER withPassword(String dbmsName,
                     char[] password)

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!

Parameters:

dbmsName - the name of the dbms

password - to use for the named dbms

Returns:

this instance

withPassword

default <I extends HasDbmsId> BUILDER withPassword(I id,
                                                   char[] password)

Configures a password for the identified 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

password - to use for the identified dbms

Returns:

this instance

withPassword

BUILDER withPassword(String password)

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!

Parameters:

password - to use for all dbms:es in this project

Returns:

this instance

withPassword

BUILDER withPassword(String dbmsName,
                     String password)

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!

Parameters:

dbmsName - the name of the dbms

password - to use for the named dbms

Returns:

this instance

withPassword

default <I extends HasDbmsId> BUILDER withPassword(I id,
                                                   String password)

Configures a password for the identified 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

password - to use for the identified dbms

Returns:

this instance

withUsername

BUILDER withUsername(String username)

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.

Parameters:

username - to use for all dbms:es in this project

Returns:

this instance

withUsername

BUILDER withUsername(String dbmsName,
                     String username)

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.

Parameters:

dbmsName - the name of the dbms

username - to use for the named dbms

Returns:

this instance

withUsername

default <I extends HasDbmsId> BUILDER withUsername(I id,
                                                   String username)

Configures a username for the identified dbms. The username 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

username - to use for the identified dbms

Returns:

this instance

withIpAddress

BUILDER withIpAddress(String ipAddress)

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.

Parameters:

ipAddress - to use for all dbms:es in this project

Returns:

this instance

withIpAddress

BUILDER withIpAddress(String dbmsName,
                      String ipAddress)

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.

Parameters:

dbmsName - the name of the dbms

ipAddress - to use for the named dbms.

Returns:

this instance

withIpAddress

default <I extends HasDbmsId> BUILDER withIpAddress(I id,
                                                    String ipAddress)

Configures an IP Address for the identified dbms. The IP Address 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

ipAddress - to use for the identified dbms

Returns:

this instance

withPort

BUILDER withPort(int port)

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.

Parameters:

port - to use for all dbms:es in this project

Returns:

this instance

withPort

BUILDER withPort(String dbmsName,
                 int port)

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.

Parameters:

dbmsName - the name of the dbms

port - to use for the named dbms

Returns:

this instance

withPort

default <I extends HasDbmsId> BUILDER withPort(I id,
                                               int port)

Configures a port for the identified dbms. The port 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

port - to use for the identified dbms

Returns:

this instance

withSchema

BUILDER withSchema(String schemaName)

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.

Parameters:

schemaName - to use for all schemas this project

Returns:

this instance

withSchema

BUILDER withSchema(String oldSchemaName,
                   String schemaName)

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.

Parameters:

oldSchemaName - the current name of a schema

schemaName - to use for the named schema

Returns:

this instance

withConnectionUrl

BUILDER withConnectionUrl(String connectionUrl)

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

Parameters:

connectionUrl - to use for all dbms this project or null

Returns:

this instance

withConnectionUrl

BUILDER withConnectionUrl(String dbmsName,
                          String connectionUrl)

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

Parameters:

dbmsName - the name of the dbms

connectionUrl - to use for the named dbms or null

Returns:

this instance

withConnectionUrl

default <I extends HasDbmsId> BUILDER withConnectionUrl(I id,
                                                        String connectionUrl)

Configures a connection URL for the identified dbms. The URL 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!

Type Parameters:

I - identification type

Parameters:

id - the identification of the dbms

connectionUrl - to use for the identified dbms

Returns:

this instance

withSkipCheckDatabaseConnectivity

BUILDER withSkipCheckDatabaseConnectivity()

Sets that the initial database check shall be skipped upon build().

Returns:

this instance

withSkipValidateRuntimeConfig

BUILDER withSkipValidateRuntimeConfig()

Sets that the initial validation of the configuration shall be skipped upon build(). Useful for testing.

Returns:

this instance

withSkipLogoPrintout

BUILDER withSkipLogoPrintout()

Sets that the logo printout shall be skipped upon build().

Returns:

this instance

withManager

<M extends Manager<?>> BUILDER withManager(Class<M> managerImplType)

Adds a custom manager.

Type Parameters:

M - the manager type

Parameters:

managerImplType - the manager implementation class

Returns:

this instance

withComponent

BUILDER withComponent(Class<?> componentClass)

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 withComponent(java.lang.Class) and withBundle(java.lang.Class) is significant.

Parameters:

componentClass - the implementation class

Returns:

this instance

withBundle

BUILDER withBundle(Class<? extends com.speedment.common.injector.InjectBundle> bundleClass)

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.

Parameters:

bundleClass - to use when adding injectables

Returns:

this instance

withLogging

BUILDER withLogging(ApplicationBuilder.HasLoggerName namer)

Adds a logging configuration to the application. A number of standard log types are available in the class LogType.

Parameters:

namer - logger with the namer to turn on

Returns:

this instance

See Also:

for standard implementation

withAllowStreamIteratorAndSpliterator

BUILDER withAllowStreamIteratorAndSpliterator()

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.

Returns:

this instance

build

APP build()

Builds this application. This is expected to be the last method called on this object.

Returns:

the built application