org.jooq

Interface Scope

All Known Subinterfaces:

BindContext, BindingGetResultSetContext<U>, BindingGetSQLInputContext<U>, BindingGetStatementContext<U>, BindingRegisterContext<U>, BindingSetSQLOutputContext<U>, BindingSetStatementContext<U>, BindingSQLContext<U>, Context<C>, DSLContext, ExecuteContext, RecordContext, RenderContext, TransactionContext, VisitContext

All Known Implementing Classes:

DefaultDSLContext

public interface Scope

Scope implementations provide access to a variety of objects that are available from a given scope.

The scope of the various objects contained in this type (e.g. configuration(), settings(), etc.) are implementation dependent and will be specified by the concrete subtype of Scope.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
Configuration	configuration() The configuration of the current scope.
java.util.Map<java.lang.Object,java.lang.Object>	data() Get all custom data from this Scope.
java.lang.Object	data(java.lang.Object key) Get some custom data from this Scope.
java.lang.Object	data(java.lang.Object key, java.lang.Object value) Set some custom data to this Scope.
SQLDialect	dialect() The SQLDialect wrapped by this context.
SQLDialect	family() The SQLDialect.family() wrapped by this context.
Settings	settings() The settings wrapped by this context.

Method Detail

configuration

Configuration configuration()

The configuration of the current scope.

settings

Settings settings()

The settings wrapped by this context.

This method is a convenient way of accessing configuration().settings().

dialect

SQLDialect dialect()

The SQLDialect wrapped by this context.

This method is a convenient way of accessing configuration().dialect().

family

SQLDialect family()

The SQLDialect.family() wrapped by this context.

This method is a convenient way of accessing configuration().dialect().family().

data

java.util.Map<java.lang.Object,java.lang.Object> data()

Get all custom data from this Scope.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given Scope.

Returns:

The custom data. This is never null

data

java.lang.Object data(java.lang.Object key)

Get some custom data from this Scope.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given Scope

Parameters:

key - A key to identify the custom data

Returns:

The custom data or null if no such data is contained in this Scope

data

java.lang.Object data(java.lang.Object key,
                      java.lang.Object value)

Set some custom data to this Scope.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given Scope.

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