Package io.agroal.api

Enum AgroalDataSource.FlushMode

java.lang.Object

java.lang.Enum<AgroalDataSource.FlushMode>

io.agroal.api.AgroalDataSource.FlushMode

All Implemented Interfaces:

Serializable, Comparable<AgroalDataSource.FlushMode>

Enclosing interface:

AgroalDataSource

public static enum AgroalDataSource.FlushMode
extends Enum<AgroalDataSource.FlushMode>

Modes supported on the flush operation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All connections are flushed right away.
FILL	Creates connections to met the minimum size of the pool.
GRACEFUL	Active connections are flushed on return.
IDLE	Idle connections are flushed.
INVALID	Performs on-demand validation of idle connections.
LEAK	Flushes connections that have been in use for longer than the specified leak timeout.

Method Summary

Modifier and Type	Method	Description
static AgroalDataSource.FlushMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AgroalDataSource.FlushMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final AgroalDataSource.FlushMode ALL

All connections are flushed right away.

IDLE

public static final AgroalDataSource.FlushMode IDLE

Idle connections are flushed.

INVALID

public static final AgroalDataSource.FlushMode INVALID

Performs on-demand validation of idle connections.

GRACEFUL

public static final AgroalDataSource.FlushMode GRACEFUL

Active connections are flushed on return. Idle connections are flushed immediately.

LEAK

public static final AgroalDataSource.FlushMode LEAK

Flushes connections that have been in use for longer than the specified leak timeout.

FILL

public static final AgroalDataSource.FlushMode FILL

Creates connections to met the minimum size of the pool. Used after and increase of minimum size, to make that change effective immediately.

Method Details

values

public static AgroalDataSource.FlushMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AgroalDataSource.FlushMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null