Top Fields Constructors Methods
org.jooq.impl

pack-priv abstract Class AbstractScope

extends Object
implements Scope
Class Inheritance
All Implemented Interfaces
org.jooq.Scope
Known Direct Subclasses
org.jooq.impl.DefaultBindingSQLContext, org.jooq.impl.DefaultCacheContext, org.jooq.impl.DefaultConverterContext, org.jooq.impl.DefaultDiagnosticsContext, org.jooq.impl.DefaultDSLContext, org.jooq.impl.DefaultTransactionContext, org.jooq.impl.SimpleExecuteContext, org.jooq.impl.AbstractContext, org.jooq.impl.AbstractExecuteScope, org.jooq.impl.DefaultGeneratorContext, org.jooq.impl.DefaultMigrationContext, org.jooq.impl.DefaultRecordContext, org.jooq.impl.MigrationImpl, org.jooq.impl.DefaultParseContext, org.jooq.impl.AbstractMeta
Imports
java.time.Instant, java.util.Map, org.jooq.Configuration, .DSLContext, .SQLDialect, .Scope, org.jooq.conf.Settings
Author
Lukas Eder

Field Summary

Modifier and TypeField and Description
pack-priv final Configuration
configuration

pack-priv final Instant
creationTime

pack-priv final Map<Object, Object>
data

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractScope(Configuration configuration)

pack-priv
AbstractScope(Configuration configuration, Map<Object, Object> data)

Method Summary

Modifier and TypeMethod and Description
public final Configuration
configuration()

Implements org.jooq.Scope.configuration.

The configuration of the current scope.
public final Instant
creationTime()

Implements org.jooq.Scope.creationTime.

The time, according to Configuration#clock(), when this Scope was created.
public final Map<Object, Object>
data()

Implements org.jooq.Scope.data.

Get all custom data from this Scope.
public final Object
data(Object
A key to identify the custom data
key)

Implements org.jooq.Scope.data.

Get some custom data from this Scope.
public final Object
data(Object
A key to identify the custom data
key, Object
The custom data
value)

Implements org.jooq.Scope.data.

Set some custom data to this Scope.
public final SQLDialect
dialect()

Implements org.jooq.Scope.dialect.

The SQLDialect wrapped by this context.
public final DSLContext
dsl()

Implements org.jooq.Scope.dsl.

Wrap the configuration() in a DSLContext, providing access to the configuration-contextual DSL to construct executable queries.
public final SQLDialect
family()

Implements org.jooq.Scope.family.

The SQLDialect#family() wrapped by this context.
public final Settings
settings()

Implements org.jooq.Scope.settings.

The settings wrapped by this context.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
pack-priv final Configuration configuration
creationTimeback to summary
pack-priv final Instant creationTime
databack to summary
pack-priv final Map<Object, Object> data

Constructor Detail

AbstractScopeback to summary
pack-priv AbstractScope(Configuration configuration)
AbstractScopeback to summary
pack-priv AbstractScope(Configuration configuration, Map<Object, Object> data)

Method Detail

configurationback to summary
public final Configuration configuration()

Implements org.jooq.Scope.configuration.

Doc from org.jooq.Scope.configuration.

The configuration of the current scope.

Annotations
@Override
creationTimeback to summary
public final Instant creationTime()

Implements org.jooq.Scope.creationTime.

Doc from org.jooq.Scope.creationTime.

The time, according to Configuration#clock(), when this Scope was created.

Annotations
@Override
databack to summary
public final Map<Object, Object> data()

Implements org.jooq.Scope.data.

Doc from org.jooq.Scope.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:Map<Object, Object>

The custom data. This is never null

Annotations
@Override
databack to summary
public final Object data(Object key)

Implements org.jooq.Scope.data.

Doc from org.jooq.Scope.data.

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:Object

A key to identify the custom data

Returns:Object

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

Annotations
@Override
databack to summary
public final Object data(Object key, Object value)

Implements org.jooq.Scope.data.

Doc from org.jooq.Scope.data.

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:Object

A key to identify the custom data

value:Object

The custom data

Returns:Object

The previously set custom data or null if no data was previously set for the given key

Annotations
@Override
dialectback to summary
public final SQLDialect dialect()

Implements org.jooq.Scope.dialect.

Doc from org.jooq.Scope.dialect.

The SQLDialect wrapped by this context.

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

Annotations
@Override
dslback to summary
public final DSLContext dsl()

Implements org.jooq.Scope.dsl.

Doc from org.jooq.Scope.dsl.

Wrap the configuration() in a DSLContext, providing access to the configuration-contextual DSL to construct executable queries.

Annotations
@Override
familyback to summary
public final SQLDialect family()

Implements org.jooq.Scope.family.

Doc from org.jooq.Scope.family.

The SQLDialect#family() wrapped by this context.

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

Annotations
@Override
settingsback to summary
public final Settings settings()

Implements org.jooq.Scope.settings.

Doc from org.jooq.Scope.settings.

The settings wrapped by this context.

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

Annotations
@Override