Modifier and Type	Class and Description
public static interface	Pool.Entry< the type of the pooled objects E> A `Pool` entry that holds metadata and a pooled object.
public static interface	Pool.Factory< the type of the pooled objects F> A factory for `Pool` instances.
public static class	Pool.Wrapper< the type of the pooled objects W> A wrapper for `Pool` instances.

Modifier and Type	Method and Description
public Pool.Entry<P>	Returns: an entry from the pool or null if none is available. acquire() Acquires an entry from the pool.
public default Pool.Entry<P>	Returns: an entry from the pool or null if none is available. acquire(Function<Pool.Entry<P>, P> a function to create the pooled value for a reserved entry. creator) Acquires an entry from the pool, reserving and creating a new entry if necessary.
public default int	Returns: the number of idle entries getIdleCount()
public default int	Returns: the number of in-use entries getInUseCount()
public int	Returns: the maximum number of entries in this `Pool` getMaxSize()
public default int	Returns: the number of reserved entries getReservedCount()
public default int	Returns: the number of terminated entries getTerminatedCount()
public boolean	Returns: whether this `Pool` has been terminated isTerminated()
public Pool.Entry<P>	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 reserve() Creates a new disabled slot into the pool.
public int	Returns: the current number of entries in this `Pool` size()
public Stream<Pool.Entry<P>>	Returns: a `Stream` over the entries stream()
public Collection<Pool.Entry<P>>	Returns: a list of all entries terminate() Terminates this `Pool`.

Method Detail

acquire back to summary

acquire	back to summary
public Pool.Entry<P> acquire() Acquires an entry from the pool. Only enabled entries will be returned from this method and their `Entry#enable(Object, boolean)` method must not be called. Returns:Pool.Entry<P> an entry from the pool or null if none is available.

public Pool.Entry acquire()

Acquires an entry from the pool.

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

Returns:Pool.Entry: an entry from the pool or null if none is available.

acquire	back to summary
public default Pool.Entry<P> acquire(Function<Pool.Entry<P>, P> creator) Acquires an entry from the pool, reserving and creating a new entry if necessary. Parameters creator:Function<Pool.Entry<P>, P> a function to create the pooled value for a reserved entry. Returns:Pool.Entry<P> an entry from the pool or null if none is available.

acquire

back to summary

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

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

Parameters

creator:Function<Pool.Entry, P>: a function to create the pooled value for a reserved entry.

Returns:Pool.Entry

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

getIdleCount	back to summary
public default int getIdleCount() Returns:int the number of idle entries Annotations @ManagedAttribute:The number of idle entries

getInUseCount	back to summary
public default int getInUseCount() Returns:int the number of in-use entries Annotations @ManagedAttribute:The number of in-use entries

getMaxSize	back to summary
public int getMaxSize() Returns:int the maximum number of entries in this `Pool` Annotations @ManagedAttribute:The maximum number of entries

getReservedCount	back to summary
public default int getReservedCount() Returns:int the number of reserved entries Annotations @ManagedAttribute:The number of reserved entries

getTerminatedCount	back to summary
public default int getTerminatedCount() Returns:int the number of terminated entries Annotations @ManagedAttribute:The number of terminated entries

isTerminated	back to summary
public boolean isTerminated() Returns:boolean whether this `Pool` has been terminated See Also `terminate()`

reserve back to summary

reserve	back to summary
public Pool.Entry<P> reserve() Creates a new disabled slot into the pool. The returned entry must ultimately have the `Entry#enable(Object, boolean)` method called or be removed via `Pool.Entry#remove()`. Returns:Pool.Entry<P> a disabled entry that is contained in the pool, or `null` if the pool is terminated or if the pool cannot reserve an entry

public Pool.Entry reserve()

Creates a new disabled slot into the pool.

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

Returns:Pool.Entry: a disabled entry that is contained in the pool, or null if the pool is terminated or if the pool cannot reserve an entry

size	back to summary
public int size() Returns:int the current number of entries in this `Pool` Annotations @ManagedAttribute:The number of entries

stream	back to summary
public Stream<Pool.Entry<P>> stream() Returns:Stream<Pool.Entry<P>> a `Stream` over the entries

terminate back to summary

terminate	back to summary
public Collection<Pool.Entry<P>> terminate() 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. Returns:Collection<Pool.Entry<P>> a list of all entries

public Collection<Pool.Entry> terminate()

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.

Returns:Collection<Pool.Entry>: a list of all entries

org.eclipse.jetty.util back to summary

public Interface Pool.Entry<E>

Known Direct Implementers

org.eclipse.jetty.util.Pool.Entry.Wrapper, org.eclipse.jetty.util.ConcurrentPool.ConcurrentEntry

Type Parameters

<E>: the type of the pooled objects

A Pool entry that holds metadata and a pooled object.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Pool.Entry.Wrapper< the type of the pooled objects W> A wrapper for `Entry` instances.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether this `Entry` was enabled enable(E the pooled object for this `Entry` pooled, boolean whether this `Entry` should be atomically enabled and acquired acquire) Enables this, previously `reserved`, `Entry`.
public E	Returns: the pooled object getPooled()
public boolean	Returns: whether this `Entry` is idle in the `Pool` isIdle()
public boolean	Returns: whether this `Entry` is in use isInUse()
public boolean	Returns: whether this `Entry` is reserved isReserved()
public boolean	Returns: whether this `Entry` is terminated isTerminated()
public boolean	Returns: whether this `Entry` was released release() Releases this `Entry` to the `Pool`.
public boolean	Returns: whether this `Entry` was removed remove() Removes this `Entry` from the `Pool`.

Method Detail

enable back to summary

enable	back to summary
public boolean enable(E pooled, boolean acquire) Enables this, previously `reserved`, `Entry`. An entry returned from the `reserve()` method must be enabled with this method, once and only once, before it is usable by the pool. The entry may be enabled and not acquired, in which case it is immediately available to be acquired, potentially by another thread; or it can be enabled and acquired atomically so that no other thread can acquire it, although the acquire may still fail if the pool has been terminated. Parameters pooled:E the pooled object for this `Entry` acquire:boolean whether this `Entry` should be atomically enabled and acquired Returns:boolean whether this `Entry` was enabled Exceptions IllegalStateException: if this `Entry` was already enabled

public boolean enable(E pooled, boolean acquire)

Enables this, previously reserved, Entry.

An entry returned from the reserve() method must be enabled with this method, once and only once, before it is usable by the pool.

The entry may be enabled and not acquired, in which case it is immediately available to be acquired, potentially by another thread; or it can be enabled and acquired atomically so that no other thread can acquire it, although the acquire may still fail if the pool has been terminated.

Parameters

pooled:E: the pooled object for this Entry
acquire:boolean: whether this Entry should be atomically enabled and acquired

Returns:boolean

whether this Entry was enabled

Exceptions

IllegalStateException:: if this Entry was already enabled

getPooled	back to summary
public E getPooled() Returns:E the pooled object

isIdle	back to summary
public boolean isIdle() Returns:boolean whether this `Entry` is idle in the `Pool`

isInUse	back to summary
public boolean isInUse() Returns:boolean whether this `Entry` is in use

isReserved	back to summary
public boolean isReserved() Returns:boolean whether this `Entry` is reserved See Also `Pool#reserve()`

isTerminated	back to summary
public boolean isTerminated() Returns:boolean whether this `Entry` is terminated

release back to summary

release	back to summary
public boolean release() Releases this `Entry` to the `Pool`. Returns:boolean whether this `Entry` was released

public boolean release()

Releases this Entry to the Pool.

Returns:boolean: whether this Entry was released

remove back to summary

remove	back to summary
public boolean remove() Removes this `Entry` from the `Pool`. Returns:boolean whether this `Entry` was removed

public boolean remove()

Removes this Entry from the Pool.

Returns:boolean: whether this Entry was removed

org.eclipse.jetty.util back to summary

public Class Pool.Entry.Wrapper<W>

Class Inheritance

extends Object
implements Pool.Entry<W>

java.lang.Object
org.eclipse.jetty.util.Pool.Entry.Wrapper

All Implemented Interfaces

org.eclipse.jetty.util.Pool.Entry

Known Direct Subclasses

org.eclipse.jetty.util.LockedPool.LockedEntry

Type Parameters

<W>: the type of the pooled objects

A wrapper for Entry instances.

Field Summary

Modifier and Type	Field and Description
private final Pool.Entry<W>	wrapped

Constructor Summary

Access	Constructor and Description
public	Wrapper(Pool.Entry<W> wrapped)

Method Summary

Modifier and Type	Method and Description
public boolean	enable(W the pooled object for this `Entry` pooled, boolean whether this `Entry` should be atomically enabled and acquired acquire) Implements org.eclipse.jetty.util.Pool.Entry.enable. Enables this, previously `reserved`, `Entry`.
public W	getPooled() Implements org.eclipse.jetty.util.Pool.Entry.getPooled.
public Pool.Entry<W>	getWrapped()
public boolean	isIdle() Implements org.eclipse.jetty.util.Pool.Entry.isIdle.
public boolean	isInUse() Implements org.eclipse.jetty.util.Pool.Entry.isInUse.
public boolean	isReserved() Implements org.eclipse.jetty.util.Pool.Entry.isReserved.
public boolean	isTerminated() Implements org.eclipse.jetty.util.Pool.Entry.isTerminated.
public boolean	release() Implements org.eclipse.jetty.util.Pool.Entry.release. Releases this `Entry` to the `Pool`.
public boolean	remove() Implements org.eclipse.jetty.util.Pool.Entry.remove. Removes this `Entry` from the `Pool`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

wrapped	back to summary
private final Pool.Entry<W> wrapped

Constructor Detail

Wrapper	back to summary
public Wrapper(Pool.Entry<W> wrapped)

Method Detail

enable back to summary

enable	back to summary
public boolean enable(W pooled, boolean acquire) Implements org.eclipse.jetty.util.Pool.Entry.enable. Doc from org.eclipse.jetty.util.Pool.Entry.enable. Enables this, previously `reserved`, `Entry`. An entry returned from the `reserve()` method must be enabled with this method, once and only once, before it is usable by the pool. The entry may be enabled and not acquired, in which case it is immediately available to be acquired, potentially by another thread; or it can be enabled and acquired atomically so that no other thread can acquire it, although the acquire may still fail if the pool has been terminated. Parameters pooled:W the pooled object for this `Entry` acquire:boolean whether this `Entry` should be atomically enabled and acquired Returns:boolean whether this `Entry` was enabled Annotations @Override

public boolean enable(W pooled, boolean acquire)

Implements org.eclipse.jetty.util.Pool.Entry.enable.

Doc from org.eclipse.jetty.util.Pool.Entry.enable.

Enables this, previously reserved, Entry.

An entry returned from the reserve() method must be enabled with this method, once and only once, before it is usable by the pool.

Parameters

pooled:W: the pooled object for this Entry
acquire:boolean: whether this Entry should be atomically enabled and acquired

Returns:boolean

whether this Entry was enabled

Annotations

@Override

getPooled	back to summary
public W getPooled() Implements org.eclipse.jetty.util.Pool.Entry.getPooled. Returns:W Doc from org.eclipse.jetty.util.Pool.Entry.getPooled. the pooled object Annotations @Override

getPooled

back to summary

public W getPooled()

Implements org.eclipse.jetty.util.Pool.Entry.getPooled.

Returns:W

Doc from org.eclipse.jetty.util.Pool.Entry.getPooled.

the pooled object

Annotations

@Override

getWrapped	back to summary
public Pool.Entry<W> getWrapped()

isIdle back to summary

isIdle	back to summary
public boolean isIdle() Implements org.eclipse.jetty.util.Pool.Entry.isIdle. Returns:boolean Doc from org.eclipse.jetty.util.Pool.Entry.isIdle. whether this `Entry` is idle in the `Pool` Annotations @Override

public boolean isIdle()

Implements org.eclipse.jetty.util.Pool.Entry.isIdle.

Returns:boolean

Doc from org.eclipse.jetty.util.Pool.Entry.isIdle.

whether this Entry is idle in the Pool

Annotations

@Override

isInUse back to summary

isInUse	back to summary
public boolean isInUse() Implements org.eclipse.jetty.util.Pool.Entry.isInUse. Returns:boolean Doc from org.eclipse.jetty.util.Pool.Entry.isInUse. whether this `Entry` is in use Annotations @Override

public boolean isInUse()

Implements org.eclipse.jetty.util.Pool.Entry.isInUse.

Returns:boolean

Doc from org.eclipse.jetty.util.Pool.Entry.isInUse.

whether this Entry is in use

Annotations

@Override

isReserved back to summary

isReserved	back to summary
public boolean isReserved() Implements org.eclipse.jetty.util.Pool.Entry.isReserved. Returns:boolean Doc from org.eclipse.jetty.util.Pool.Entry.isReserved. whether this `Entry` is reserved Annotations @Override

public boolean isReserved()

Implements org.eclipse.jetty.util.Pool.Entry.isReserved.

Returns:boolean

Doc from org.eclipse.jetty.util.Pool.Entry.isReserved.

whether this Entry is reserved

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements org.eclipse.jetty.util.Pool.Entry.isTerminated. Returns:boolean Doc from org.eclipse.jetty.util.Pool.Entry.isTerminated. whether this `Entry` is terminated Annotations @Override

public boolean isTerminated()

Implements org.eclipse.jetty.util.Pool.Entry.isTerminated.

Returns:boolean

Doc from org.eclipse.jetty.util.Pool.Entry.isTerminated.

whether this Entry is terminated

Annotations

@Override

release back to summary

release	back to summary
public boolean release() Implements org.eclipse.jetty.util.Pool.Entry.release. Doc from org.eclipse.jetty.util.Pool.Entry.release. Releases this `Entry` to the `Pool`. Returns:boolean whether this `Entry` was released Annotations @Override

public boolean release()

Implements org.eclipse.jetty.util.Pool.Entry.release.

Doc from org.eclipse.jetty.util.Pool.Entry.release.

Releases this Entry to the Pool.

Returns:boolean

whether this Entry was released

Annotations

@Override

remove back to summary

remove	back to summary
public boolean remove() Implements org.eclipse.jetty.util.Pool.Entry.remove. Doc from org.eclipse.jetty.util.Pool.Entry.remove. Removes this `Entry` from the `Pool`. Returns:boolean whether this `Entry` was removed Annotations @Override

public boolean remove()

Implements org.eclipse.jetty.util.Pool.Entry.remove.

Doc from org.eclipse.jetty.util.Pool.Entry.remove.

Removes this Entry from the Pool.

Returns:boolean

whether this Entry was removed

Annotations

@Override

org.eclipse.jetty.util back to summary

public Interface Pool.Factory<F>

Known Direct Subinterfaces

org.eclipse.jetty.util.LockedPool.Factory

Type Parameters

<F>: the type of the pooled objects

A factory for Pool instances.

Method Summary

Modifier and Type	Method and Description
public Pool<F>	Returns: a new `Pool` instance newPool()
public default Pool<F>	Returns: a possibly wrapped pool wrap(Pool<F> the pool to wrap pool) Wraps, if necessary, the given pool.

Method Detail

newPool	back to summary
public Pool<F> newPool() Returns:Pool<F> a new `Pool` instance

wrap back to summary

wrap	back to summary
public default Pool<F> wrap(Pool<F> pool) Wraps, if necessary, the given pool. Parameters pool:Pool<F> the pool to wrap Returns:Pool<F> a possibly wrapped pool See Also `Pool.Wrapper`

public default Pool<F> wrap(Pool<F> pool)

Wraps, if necessary, the given pool.

Parameters

pool:Pool<F>: the pool to wrap

Returns:Pool<F>

a possibly wrapped pool

See Also

Pool.Wrapper

org.eclipse.jetty.util back to summary

public Class Pool.Wrapper<W>

Class Inheritance

extends Object
implements Pool<W>

java.lang.Object
org.eclipse.jetty.util.Pool.Wrapper

All Implemented Interfaces

org.eclipse.jetty.util.Pool

Known Direct Subclasses

org.eclipse.jetty.util.LockedPool

Type Parameters

<W>: the type of the pooled objects

A wrapper for Pool instances.

Field Summary

Modifier and Type	Field and Description
private final Pool<W>	wrapped

Constructor Summary

Access	Constructor and Description
public	Wrapper(Pool<W> wrapped)

Method Summary

Modifier and Type	Method and Description
public Pool.Entry<W>	acquire() Implements org.eclipse.jetty.util.Pool.acquire. Acquires an entry from the pool.
public Pool.Entry<W>	acquire(Function<Pool.Entry<W>, W> a function to create the pooled value for a reserved entry. creator) Overrides default org.eclipse.jetty.util.Pool.acquire. Acquires an entry from the pool, reserving and creating a new entry if necessary.
public int	getIdleCount() Overrides default org.eclipse.jetty.util.Pool.getIdleCount.
public int	getInUseCount() Overrides default org.eclipse.jetty.util.Pool.getInUseCount.
public int	getMaxSize() Implements org.eclipse.jetty.util.Pool.getMaxSize.
public int	getReservedCount() Overrides default org.eclipse.jetty.util.Pool.getReservedCount.
public int	getTerminatedCount() Overrides default org.eclipse.jetty.util.Pool.getTerminatedCount.
public Pool<W>	getWrapped()
public boolean	isTerminated() Implements org.eclipse.jetty.util.Pool.isTerminated.
public Pool.Entry<W>	reserve() Implements org.eclipse.jetty.util.Pool.reserve. Creates a new disabled slot into the pool.
public int	size() Implements org.eclipse.jetty.util.Pool.size.
public Stream<Pool.Entry<W>>	stream() Implements org.eclipse.jetty.util.Pool.stream.
public Collection<Pool.Entry<W>>	terminate() Implements org.eclipse.jetty.util.Pool.terminate. Terminates this `Pool`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

wrapped	back to summary
private final Pool<W> wrapped

wrapped

back to summary

private final Pool<W> wrapped

Constructor Detail

Wrapper	back to summary
public Wrapper(Pool<W> wrapped)

Wrapper

back to summary

public Wrapper(Pool<W> wrapped)

Method Detail

acquire back to summary

acquire	back to summary
public Pool.Entry<W> acquire() Implements org.eclipse.jetty.util.Pool.acquire. Doc from org.eclipse.jetty.util.Pool.acquire. Acquires an entry from the pool. Only enabled entries will be returned from this method and their `Entry#enable(Object, boolean)` method must not be called. Returns:Pool.Entry<W> an entry from the pool or null if none is available. Annotations @Override

public Pool.Entry<W> acquire()

Implements org.eclipse.jetty.util.Pool.acquire.

Doc from org.eclipse.jetty.util.Pool.acquire.

Acquires an entry from the pool.

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

Returns:Pool.Entry<W>

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

Annotations

@Override

acquire	back to summary
public Pool.Entry<W> acquire(Function<Pool.Entry<W>, W> creator) Overrides default org.eclipse.jetty.util.Pool.acquire. Doc from org.eclipse.jetty.util.Pool.acquire. Acquires an entry from the pool, reserving and creating a new entry if necessary. Parameters creator:Function<Pool.Entry<W>, W> a function to create the pooled value for a reserved entry. Returns:Pool.Entry<W> an entry from the pool or null if none is available. Annotations @Override

acquire

back to summary

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

Overrides default org.eclipse.jetty.util.Pool.acquire.

Doc from org.eclipse.jetty.util.Pool.acquire.

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

Parameters

creator:Function<Pool.Entry<W>, W>: a function to create the pooled value for a reserved entry.

Returns:Pool.Entry<W>

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

Annotations

@Override

getIdleCount	back to summary
public int getIdleCount() Overrides default org.eclipse.jetty.util.Pool.getIdleCount. Returns:int Doc from org.eclipse.jetty.util.Pool.getIdleCount. the number of idle entries Annotations @Override

getIdleCount

back to summary

public int getIdleCount()

Overrides default org.eclipse.jetty.util.Pool.getIdleCount.

Returns:int

Doc from org.eclipse.jetty.util.Pool.getIdleCount.

the number of idle entries

Annotations

@Override

getInUseCount	back to summary
public int getInUseCount() Overrides default org.eclipse.jetty.util.Pool.getInUseCount. Returns:int Doc from org.eclipse.jetty.util.Pool.getInUseCount. the number of in-use entries Annotations @Override

getInUseCount

back to summary

public int getInUseCount()

Overrides default org.eclipse.jetty.util.Pool.getInUseCount.

Returns:int

Doc from org.eclipse.jetty.util.Pool.getInUseCount.

the number of in-use entries

Annotations