Package org.ldaptive

Class AbstractConnectionValidator.AbstractBuilder<B,T extends AbstractConnectionValidator>

java.lang.Object

org.ldaptive.AbstractConnectionValidator.AbstractBuilder<B,T>

Type Parameters:

B - type of builder

T - type of validator

Direct Known Subclasses:

AbstractOperationConnectionValidator.AbstractBuilder

Enclosing class:

AbstractConnectionValidator

protected abstract static class AbstractConnectionValidator.AbstractBuilder<B,T extends AbstractConnectionValidator>
extends Object

Base class for validator builders.

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	object	Validator to build.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder(T t)	Creates a new abstract builder.

Method Summary

Modifier and Type	Method	Description
T	build()	Returns the connection validator.
B	freeze()	Makes this instance immutable.
B	onFailure(Consumer<Connection> consumer)	Sets the on failure consumer.
B	onSuccess(Consumer<Connection> consumer)	Sets the on success consumer.
B	period(Duration period)	Sets the validation period.
protected abstract B	self()	Returns this builder.
B	timeout(Duration timeout)	Sets the validation timeout.
B	timeoutIsFailure(boolean failure)	Sets whether timeout is a validation failure.

Methods inherited from class java.lang.Object

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

Field Details

object

protected final T extends AbstractConnectionValidator object

Validator to build.

Constructor Details

AbstractBuilder

protected AbstractBuilder(T t)

Creates a new abstract builder.

Parameters:

t - validator to build

Method Details

self

protected abstract B self()

Returns this builder.

Returns:

builder

freeze

public B freeze()

Makes this instance immutable.

Returns:

this builder

period

public B period(Duration period)

Sets the validation period.

Parameters:

period - to set

Returns:

this builder

timeout

public B timeout(Duration timeout)

Sets the validation timeout.

Parameters:

timeout - to set

Returns:

this builder

onSuccess

public B onSuccess(Consumer<Connection> consumer)

Sets the on success consumer.

Parameters:

consumer - to invoke on success

Returns:

this builder

onFailure

public B onFailure(Consumer<Connection> consumer)

Sets the on failure consumer.

Parameters:

consumer - to invoke on failure

Returns:

this builder

timeoutIsFailure

public B timeoutIsFailure(boolean failure)

Sets whether timeout is a validation failure.

Parameters:

failure - whether timeout is a validation failure

Returns:

this builder

build

public T build()

Returns the connection validator.

Returns:

connection validator