MockConfiguration (jOOQ 3.8.1 API)

java.lang.Object
- org.jooq.tools.jdbc.MockConfiguration

All Implemented Interfaces:

Serializable, Configuration
```
public class MockConfiguration
extends Object
implements Configuration
```
A mock configuration.
This Configuration wraps a delegate Configuration and wraps all ConnectionProvider references in MockConnectionProvider.

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MockConfiguration(Configuration delegate, MockDataProvider provider)

Constructors
Constructor and Description
`MockConfiguration(Configuration delegate, MockDataProvider provider)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionProvider`	`connectionProvider()` Get this configuration's underlying connection provider.
`ConverterProvider`	`converterProvider()` Get the configured `ConverterProvider` from this configuration.
`Map<Object,Object>`	`data()` Get all custom data from this `Configuration`.
`Object`	`data(Object key)` Get some custom data from this `Configuration`.
`Object`	`data(Object key, Object value)` Set some custom data to this `Configuration`.
`Configuration`	`derive()` Create a derived configuration from this one, without changing any properties.
`Configuration`	`derive(Connection newConnection)` Create a derived configuration from this one, with a new connection wrapped in a `DefaultConnectionProvider`.
`Configuration`	`derive(ConnectionProvider newConnectionProvider)` Create a derived configuration from this one, with a new connection provider.
`Configuration`	`derive(ConverterProvider newConverterProvider)` Create a derived configuration from this one, with new converter provider.
`Configuration`	`derive(DataSource newDataSource)` Create a derived configuration from this one, with a new data source wrapped in a `DataSourceConnectionProvider`.
`Configuration`	`derive(ExecuteListenerProvider... newExecuteListenerProviders)` Create a derived configuration from this one, with new execute listener providers.
`Configuration`	`derive(ExecutorProvider newExecutorProvider)` Create a derived configuration from this one, with a new executor provider.
`Configuration`	`derive(RecordListenerProvider... newRecordListenerProviders)` Create a derived configuration from this one, with new record listener providers.
`Configuration`	`derive(RecordMapperProvider newRecordMapperProvider)` Create a derived configuration from this one, with a new record mapper provider.
`Configuration`	`derive(Settings newSettings)` Create a derived configuration from this one, with new settings.
`Configuration`	`derive(SQLDialect newDialect)` Create a derived configuration from this one, with a new dialect.
`Configuration`	`derive(TransactionProvider newTransactionProvider)` Create a derived configuration from this one, with a new transaction provider.
`Configuration`	`derive(VisitListenerProvider... newVisitListenerProviders)` Create a derived configuration from this one, with new visit listener providers.
`SQLDialect`	`dialect()` Retrieve the configured dialect.
`ExecuteListenerProvider[]`	`executeListenerProviders()` Get the configured `ExecuteListenerProvider`s from this configuration.
`ExecutorProvider`	`executorProvider()` Get this configuration's underlying executor provider.
`SQLDialect`	`family()` Retrieve the family of the configured dialect.
`RecordListenerProvider[]`	`recordListenerProviders()` Get the configured `RecordListenerProvider`s from this configuration.
`RecordMapperProvider`	`recordMapperProvider()` Get this configuration's underlying record mapper provider.
`SchemaMapping`	`schemaMapping()` Retrieve the configured schema mapping.
`Configuration`	`set(Connection newConnection)` Change this configuration to hold a new connection wrapped in a `DefaultConnectionProvider`.
`Configuration`	`set(ConnectionProvider newConnectionProvider)` Change this configuration to hold a new connection provider.
`Configuration`	`set(ConverterProvider newConverterProvider)` Change this configuration to hold a new converter provider.
`Configuration`	`set(DataSource newDataSource)` Change this configuration to hold a new data source wrapped in a `DataSourceConnectionProvider`.
`Configuration`	`set(ExecuteListenerProvider... newExecuteListenerProviders)` Change this configuration to hold a new execute listener providers.
`Configuration`	`set(ExecutorProvider newExecutorProvider)` Change this configuration to hold a new executor provider.
`Configuration`	`set(RecordListenerProvider... newRecordListenerProviders)` Change this configuration to hold a new record listener providers.
`Configuration`	`set(RecordMapperProvider newRecordMapperProvider)` Change this configuration to hold a new record mapper provider.
`Configuration`	`set(Settings newSettings)` Change this configuration to hold a new settings.
`Configuration`	`set(SQLDialect newDialect)` Change this configuration to hold a new dialect.
`Configuration`	`set(TransactionProvider newTransactionProvider)` Change this configuration to hold a new transaction provider.
`Configuration`	`set(VisitListenerProvider... newVisitListenerProviders)` Change this configuration to hold a new visit listener providers.
`Settings`	`settings()` Retrieve the runtime configuration settings.
`TransactionProvider`	`transactionProvider()` Get this configuration's underlying transaction provider.
`VisitListenerProvider[]`	`visitListenerProviders()` TODO [#2667]

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

- Constructor Detail
  - MockConfiguration
```
public MockConfiguration(Configuration delegate,
                         MockDataProvider provider)
```
- Method Detail
  - data
```
public Map<Object,Object> data()
```
    Description copied from interface: Configuration
    
    Get all custom data from this Configuration.
    This is custom data that was previously set to the configuration using Configuration.data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    See ExecuteListener for more details.
    
    Specified by:
    
    data in interface Configuration
    
    Returns:
    
    The custom data. This is never null
    
    See Also:
    
    ExecuteListener
  - data
```
public Object data(Object key)
```
    Description copied from interface: Configuration
    
    Get some custom data from this Configuration.
    This is custom data that was previously set to the configuration using Configuration.data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    See ExecuteListener for more details.
    
    Specified by:
    
    data in interface Configuration
    
    Parameters:
    
    key - A key to identify the custom data
    
    Returns:
    
    The custom data or null if no such data is contained in this Configuration
    
    See Also:
    
    ExecuteListener
  - data
```
public Object data(Object key,
                   Object value)
```
    Description copied from interface: Configuration
    
    Set some custom data to this Configuration.
    Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    Be sure that your custom data implements Serializable if you want to serialise this Configuration or objects referencing this Configuration, e.g. your Record types.
    See ExecuteListener for more details.
    
    Specified by:
    
    data in interface Configuration
    
    Parameters:
    
    key - A key to identify the custom data
    
    value - The custom data
    
    Returns:
    
    The previously set custom data or null if no data was previously set for the given key
    
    See Also:
    
    ExecuteListener
  - connectionProvider
```
public ConnectionProvider connectionProvider()
```
    Description copied from interface: Configuration
    
    Get this configuration's underlying connection provider.
    
    Specified by:
    
    connectionProvider in interface Configuration
  - executorProvider
```
public ExecutorProvider executorProvider()
```
    Description copied from interface: Configuration
    Get this configuration's underlying executor provider.
    Asynchronous operations will call back to this SPI to obtain an executor. This applies, for example, to ResultQuery.fetchAsync().
    The following logic is applied when resolving the appropriate executor:
    1. If Configuration.executorProvider() does not return null, then ExecutorProvider.provide() is called to obtain an Executor for the asynchronous task.
    2. In the jOOQ Java 8 distribution, ForkJoinPool.commonPool() is used if ForkJoinPool.getCommonPoolParallelism() > 1
    3. A new "one thread per call" Executor is used in any other case.
    The SPI will not be called if an asynchronous operation explicitly overrides the Executor, e.g. as is the case for ResultQuery.fetchAsync(Executor).
    Specified by:
    
    executorProvider in interface Configuration
  - transactionProvider
```
public TransactionProvider transactionProvider()
```
    Description copied from interface: Configuration
    
    Get this configuration's underlying transaction provider.
    If no explicit transaction provider was specified, and if Configuration.connectionProvider() is a DefaultConnectionProvider, then this will return a DefaultTransactionProvider.
    
    Specified by:
    
    transactionProvider in interface Configuration
  - recordMapperProvider
```
public RecordMapperProvider recordMapperProvider()
```
    Description copied from interface: Configuration
    
    Get this configuration's underlying record mapper provider.
    
    Specified by:
    
    recordMapperProvider in interface Configuration
  - recordListenerProviders
```
public RecordListenerProvider[] recordListenerProviders()
```
    Description copied from interface: Configuration
    Get the configured RecordListenerProviders from this configuration.
    This method allows for retrieving the configured RecordListenerProvider from this configuration. The providers will provide jOOQ with RecordListener instances. These instances receive record manipulation notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may
    - share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
    - share the lifecycle of an RecordContext (i.e. that of a single record manipulation)
    - follow an entirely different lifecycle.
    Specified by:
    
    recordListenerProviders in interface Configuration
    
    Returns:
    
    The configured set of record listeners.
    
    See Also:
    
    RecordListenerProvider, RecordListener, RecordContext
  - executeListenerProviders
```
public ExecuteListenerProvider[] executeListenerProviders()
```
    Description copied from interface: Configuration
    Get the configured ExecuteListenerProviders from this configuration.
    This method allows for retrieving the configured ExecuteListenerProvider from this configuration. The providers will provide jOOQ with ExecuteListener instances. These instances receive execution lifecycle notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may
    - share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
    - share the lifecycle of an ExecuteContext (i.e. that of a single query execution)
    - follow an entirely different lifecycle.
    Note, depending on your Settings.isExecuteLogging(), some additional listeners may be prepended to this list, internally. Those listeners will never be exposed through this method, though.
    Specified by:
    
    executeListenerProviders in interface Configuration
    
    Returns:
    
    The configured set of execute listeners.
    
    See Also:
    
    ExecuteListenerProvider, ExecuteListener, ExecuteContext
  - visitListenerProviders
```
public VisitListenerProvider[] visitListenerProviders()
```
    Description copied from interface: Configuration
    
    TODO [#2667]
    
    Specified by:
    
    visitListenerProviders in interface Configuration
  - converterProvider
```
public ConverterProvider converterProvider()
```
    Description copied from interface: Configuration
    
    Get the configured ConverterProvider from this configuration.
    
    Specified by:
    
    converterProvider in interface Configuration
  - schemaMapping
```
public SchemaMapping schemaMapping()
```
    Description copied from interface: Configuration
    
    Retrieve the configured schema mapping.
    
    Specified by:
    
    schemaMapping in interface Configuration
  - dialect
```
public SQLDialect dialect()
```
    Description copied from interface: Configuration
    
    Retrieve the configured dialect.
    
    Specified by:
    
    dialect in interface Configuration
  - family
```
public SQLDialect family()
```
    Description copied from interface: Configuration
    
    Retrieve the family of the configured dialect.
    
    Specified by:
    
    family in interface Configuration
  - settings
```
public Settings settings()
```
    Description copied from interface: Configuration
    
    Retrieve the runtime configuration settings.
    
    Specified by:
    
    settings in interface Configuration
  - set
```
public Configuration set(ConnectionProvider newConnectionProvider)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new connection provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newConnectionProvider - The new connection provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(Connection newConnection)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new connection wrapped in a DefaultConnectionProvider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newConnection - The new connection to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(DataSource newDataSource)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new data source wrapped in a DataSourceConnectionProvider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(ExecutorProvider newExecutorProvider)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new executor provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newExecutorProvider - The new executor provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(TransactionProvider newTransactionProvider)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new transaction provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newTransactionProvider - The new transaction provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(RecordMapperProvider newRecordMapperProvider)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new record mapper provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newRecordMapperProvider - The new record mapper provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(RecordListenerProvider... newRecordListenerProviders)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new record listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newRecordListenerProviders - The new record listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(ExecuteListenerProvider... newExecuteListenerProviders)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new execute listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newExecuteListenerProviders - The new execute listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(VisitListenerProvider... newVisitListenerProviders)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new visit listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newVisitListenerProviders - The new visit listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(ConverterProvider newConverterProvider)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new converter provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newConverterProvider - The new converter provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(SQLDialect newDialect)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new dialect.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newDialect - The new dialect to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
public Configuration set(Settings newSettings)
```
    Description copied from interface: Configuration
    
    Change this configuration to hold a new settings.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Specified by:
    
    set in interface Configuration
    
    Parameters:
    
    newSettings - The new settings to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - derive
```
public Configuration derive()
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, without changing any properties.
    
    Specified by:
    
    derive in interface Configuration
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(ConnectionProvider newConnectionProvider)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new connection provider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newConnectionProvider - The new connection provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(ExecutorProvider newExecutorProvider)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new executor provider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newExecutorProvider - The new executor provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(Connection newConnection)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new connection wrapped in a DefaultConnectionProvider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newConnection - The new connection to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(DataSource newDataSource)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new data source wrapped in a DataSourceConnectionProvider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newDataSource - The new data source to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(TransactionProvider newTransactionProvider)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new transaction provider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newTransactionProvider - The new transaction provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(RecordMapperProvider newRecordMapperProvider)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new record mapper provider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newRecordMapperProvider - The new record mapper provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(RecordListenerProvider... newRecordListenerProviders)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with new record listener providers.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newRecordListenerProviders - The new record listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(ExecuteListenerProvider... newExecuteListenerProviders)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with new execute listener providers.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newExecuteListenerProviders - The new execute listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(VisitListenerProvider... newVisitListenerProviders)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with new visit listener providers.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newVisitListenerProviders - The new visit listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(ConverterProvider newConverterProvider)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with new converter provider.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newConverterProvider - The new converter provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(SQLDialect newDialect)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with a new dialect.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newDialect - The new dialect to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
public Configuration derive(Settings newSettings)
```
    Description copied from interface: Configuration
    
    Create a derived configuration from this one, with new settings.
    
    Specified by:
    
    derive in interface Configuration
    
    Parameters:
    
    newSettings - The new settings to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.

Class MockConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockConfiguration

Method Detail

data

data

data

connectionProvider

executorProvider

transactionProvider

recordMapperProvider

recordListenerProviders

executeListenerProviders

visitListenerProviders

converterProvider

schemaMapping

dialect

family

settings

set

set

set

set

set

set

set

set

set

set

set

set

derive

derive

derive

derive

derive

derive

derive

derive

derive

derive

derive

derive

derive