Module is.codion.framework.db.core

Package is.codion.framework.db

Class AbstractEntityConnectionProvider.AbstractBuilder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

java.lang.Object

is.codion.framework.db.AbstractEntityConnectionProvider.AbstractBuilder<T,B>

Type Parameters:

T - the EntityConnectionProvider type built by this builder

B - the builder type

All Implemented Interfaces:

EntityConnectionProvider.Builder<T,B>

Direct Known Subclasses:

DefaultHttpEntityConnectionProviderBuilder, DefaultLocalEntityConnectionProviderBuilder, DefaultRemoteEntityConnectionProviderBuilder

Enclosing class:

AbstractEntityConnectionProvider

public abstract static class AbstractEntityConnectionProvider.AbstractBuilder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>
extends Object
implements EntityConnectionProvider.Builder<T,B>

An abstract EntityConnectionProvider.Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder(String connectionType)

Method Summary

Modifier and Type	Method	Description
final B	clientId(UUID clientId)
final B	clientType(String clientType)	If no client type is specified, DomainType.name() is used.
final B	clientVersion(@Nullable Version clientVersion)
final String	connectionType()	Returns a String specifying the type of connection provided by this connection provider builder
final B	domain(DomainType domain)
final B	onClose(Consumer<EntityConnectionProvider> onClose)
final B	user(User user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface is.codion.framework.db.EntityConnectionProvider.Builder

build

Constructor Details

AbstractBuilder

protected AbstractBuilder(String connectionType)

Parameters:

connectionType - a string describing the connection type

Method Details

connectionType

public final String connectionType()

Description copied from interface: EntityConnectionProvider.Builder

Returns a String specifying the type of connection provided by this connection provider builder

Specified by:

connectionType in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Returns:

a String specifying the type of connection, e.g. "local" or "remote"

user

public final B user(User user)

Specified by:

user in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

user - the user

Returns:

this builder instance

domain

public final B domain(DomainType domain)

Specified by:

domain in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

domain - the domain type to base this connection on

Returns:

this builder instance

clientId

public final B clientId(UUID clientId)

Specified by:

clientId in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

clientId - the UUID identifying this client connection

Returns:

this builder instance

clientType

public final B clientType(String clientType)

Description copied from interface: EntityConnectionProvider.Builder

If no client type is specified, DomainType.name() is used.

Specified by:

clientType in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

clientType - a String identifying the client type for this connection provider

Returns:

this builder instance

See Also:

• EntityConnectionProvider.Builder.domain(DomainType)

clientVersion

public final B clientVersion(@Nullable Version clientVersion)

Specified by:

clientVersion in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

clientVersion - the client version

Returns:

this builder instance

onClose

public final B onClose(Consumer<EntityConnectionProvider> onClose)

Specified by:

onClose in interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Parameters:

onClose - called when this connection provider has been closed

Returns:

this builder instance

See Also:

• EntityConnectionProvider.close()