Module org.eclipse.jetty.util

Package org.eclipse.jetty.util

Class Pool.Wrapper<W>

java.lang.Object

org.eclipse.jetty.util.Pool.Wrapper<W>

Type Parameters:

W - the type of the pooled objects

All Implemented Interfaces:

Pool<W>

Direct Known Subclasses:

LockedPool

Enclosing interface:

Pool<P>

public static class Pool.Wrapper<W>
extends Object
implements Pool<W>

A wrapper for Pool instances.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Pool

Pool.Entry<E>, Pool.Factory<F>, Pool.Wrapper<W>

Constructor Summary

Constructors

Constructor	Description
Wrapper(Pool<W> wrapped)

Method Summary

Modifier and Type	Method	Description
Pool.Entry<W>	acquire()	Acquires an entry from the pool.
Pool.Entry<W>	acquire(Function<Pool.Entry<W>,W> creator)	Acquires an entry from the pool, reserving and creating a new entry if necessary.
int	getIdleCount()
int	getInUseCount()
int	getMaxSize()
int	getReservedCount()
int	getTerminatedCount()
Pool<W>	getWrapped()
boolean	isTerminated()
Pool.Entry<W>	reserve()	Creates a new disabled slot into the pool.
int	size()
Stream<Pool.Entry<W>>	stream()
Collection<Pool.Entry<W>>	terminate()	Terminates this Pool.

Methods inherited from class java.lang.Object

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

Constructor Details

Wrapper

public Wrapper(Pool<W> wrapped)

Method Details

getWrapped

public Pool<W> getWrapped()

reserve

public Pool.Entry<W> reserve()

Description copied from interface: Pool

Creates a new disabled slot into the pool.

The returned entry must ultimately have the Pool.Entry.enable(Object, boolean) method called or be removed via Pool.Entry.remove().

Specified by:

reserve in interface Pool<W>

Returns:

a disabled entry that is contained in the pool, or null if the pool is terminated or if the pool cannot reserve an entry

acquire

public Pool.Entry<W> acquire()

Description copied from interface: Pool

Acquires an entry from the pool.

Only enabled entries will be returned from this method and their Pool.Entry.enable(Object, boolean) method must not be called.

Specified by:

acquire in interface Pool<W>

Returns:

an entry from the pool or null if none is available.

acquire

public Pool.Entry<W> acquire(Function<Pool.Entry<W>,W> creator)

Description copied from interface: Pool

Acquires an entry from the pool, reserving and creating a new entry if necessary.

Specified by:

acquire in interface Pool<W>

Parameters:

creator - a function to create the pooled value for a reserved entry.

Returns:

an entry from the pool or null if none is available.

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface Pool<W>

Returns:

whether this Pool has been terminated

See Also:

• Pool.terminate()

terminate

public Collection<Pool.Entry<W>> terminate()

Description copied from interface: Pool

Terminates this Pool.

All the entries are marked as terminated and cannot be acquired nor released, but only removed.

The returned list of all entries may be iterated to perform additional operations on the pooled objects.

The pool cannot be used anymore after it is terminated.

Specified by:

terminate in interface Pool<W>

Returns:

a list of all entries

size

public int size()

Specified by:

size in interface Pool<W>

Returns:

the current number of entries in this Pool

getMaxSize

public int getMaxSize()

Specified by:

getMaxSize in interface Pool<W>

Returns:

the maximum number of entries in this Pool

stream

public Stream<Pool.Entry<W>> stream()

Specified by:

stream in interface Pool<W>

Returns:

a Stream over the entries

getReservedCount

public int getReservedCount()

Specified by:

getReservedCount in interface Pool<W>

Returns:

the number of reserved entries

getIdleCount

public int getIdleCount()

Specified by:

getIdleCount in interface Pool<W>

Returns:

the number of idle entries

getInUseCount

public int getInUseCount()

Specified by:

getInUseCount in interface Pool<W>

Returns:

the number of in-use entries

getTerminatedCount

public int getTerminatedCount()

Specified by:

getTerminatedCount in interface Pool<W>

Returns:

the number of terminated entries