Module com.github.robtimus.pool

Package com.github.robtimus.pool

Class PoolConfig

java.lang.Object

com.github.robtimus.pool.PoolConfig

public final class PoolConfig
extends Object

Configuration for Pool instances.

Instances of this class are immutable and thread-safe.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PoolConfig.Builder	A builder for PoolConfig objects.

Method Summary

Modifier and Type	Method	Description
static PoolConfig.Builder	custom()	Returns a new builder for creating PoolConfig objects.
static PoolConfig	defaultConfig()	Returns a default PoolConfig object.
int	initialSize()	Returns the initial pool size.
Optional<Duration>	maxIdleTime()	Returns the maximum time that objects can be idle.
int	maxSize()	Returns the maximum pool size.
Optional<Duration>	maxWaitTime()	Returns the maximum time to wait when acquiring objects.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

maxWaitTime

public Optional<Duration> maxWaitTime()

Returns the maximum time to wait when acquiring objects.

Returns:

An Optional describing the maximum time to wait when acquiring objects, or Optional#empty() to wait indefinitely.

maxIdleTime

public Optional<Duration> maxIdleTime()

Returns the maximum time that objects can be idle.

Returns:

An Optional describing the maximum time that objects can be idle, or Optional.empty() if objects can be idle indefinitely.

initialSize

public int initialSize()

Returns the initial pool size. This is the number of idle objects to start with.

Returns:

The initial pool size.

maxSize

public int maxSize()

Returns the maximum pool size. This is the maximum number of objects, both idle and currently in use.

Returns:

The maximum pool size.

toString

public String toString()

Overrides:

toString in class Object

defaultConfig

public static PoolConfig defaultConfig()

Returns a default PoolConfig object. This has the same configuration as an object returned by custom().build().

Returns:

A default PoolConfig object.

See Also:

custom()

custom

public static PoolConfig.Builder custom()

Returns a new builder for creating PoolConfig objects.

Returns:

A new builder for creating PoolConfig objects.