Module is.codion.framework.db

Package is.codion.framework.db

Class AbstractEntityConnection.AbstractBuilder<T extends EntityConnection,B extends EntityConnection.Builder<T,B>>

java.lang.Object

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

Type Parameters:

T - the EntityConnection type built by this builder

B - the builder type

All Implemented Interfaces:

EntityConnection.Builder<T,B>

Direct Known Subclasses:

DefaultHttpEntityConnectionBuilder, DefaultLocalEntityConnectionBuilder, DefaultRemoteEntityConnectionBuilder

Enclosing class:

AbstractEntityConnection

public abstract static class AbstractEntityConnection.AbstractBuilder<T extends EntityConnection,B extends EntityConnection.Builder<T,B>>
extends Object
implements EntityConnection.Builder<T,B>

An abstract EntityConnection.Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder(String connectionType)

Method Summary

Modifier and Type	Method	Description
final T	build()	Builds the connection and establishes the underlying one, so that one which can not be established is reported here rather than on first use, which login flows rely on.
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)
protected abstract T	createConnection()
final B	domain(Domain domain)	Sets the domain by instance, and thereby its type.
final B	domain(DomainType domainType)	Sets the domain by type, leaving a connection needing the domain in-process to resolve an instance via ServiceLoader.
final boolean	supports(String connectionType)
final B	user(User user)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder(String connectionType)

Parameters:

connectionType - a string describing the connection type

Method Details

supports

public final boolean supports(String connectionType)

Specified by:

supports in interface EntityConnection.Builder<T extends EntityConnection,B extends EntityConnection.Builder<T,B>>

Parameters:

connectionType - the connection type

Returns:

true if this builder supports the given connection type, e.g. "local", "remote" or "http"

user

public final B user(User user)

Specified by:

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

Parameters:

user - the user

Returns:

this builder instance

domain

public final B domain(DomainType domainType)

Description copied from interface: EntityConnection.Builder

Sets the domain by type, leaving a connection needing the domain in-process to resolve an instance via ServiceLoader.

Discards an instance previously set via EntityConnection.Builder.domain(Domain) unless it is of this type.

Specified by:

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

Parameters:

domainType - the domain type to base this connection on

Returns:

this builder instance

See Also:

• EntityConnection.Builder.domain(Domain)

domain

public final B domain(Domain domain)

Description copied from interface: EntityConnection.Builder

Sets the domain by instance, and thereby its type. Connections which run the domain in-process (a local connection for example) use the given instance directly, instead of resolving one via ServiceLoader from its Domain.type().

Supplying an instance keeps the ServiceLoader out of the picture entirely.

Specified by:

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

Parameters:

domain - the domain instance to base this connection on

Returns:

this builder instance

See Also:

• EntityConnection.Builder.domain(DomainType)

clientId

public final B clientId(UUID clientId)

Specified by:

clientId in interface EntityConnection.Builder<T extends EntityConnection,B extends EntityConnection.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: EntityConnection.Builder

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

Specified by:

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

Parameters:

clientType - a String identifying the client type for this connection

Returns:

this builder instance

See Also:

• EntityConnection.Builder.domain(DomainType)

clientVersion

public final B clientVersion(@Nullable Version clientVersion)

Specified by:

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

Parameters:

clientVersion - the client version

Returns:

this builder instance

build

public final T build()

Builds the connection and establishes the underlying one, so that one which can not be established is reported here rather than on first use, which login flows rely on.

Specified by:

build in interface EntityConnection.Builder<T extends EntityConnection,B extends EntityConnection.Builder<T,B>>

Returns:

a new connected EntityConnection instance

createConnection

protected abstract T createConnection()

Returns:

a new, as yet unconnected, AbstractEntityConnection based on this builder