API for object pools that control creation and possible reuse of objects that are costly to create (often things like encoding/decoding buffers).

Also contains partial (base) implementations for pools that use different strategies on retaining objects for reuse. Following implementations are included:

NonRecyclingPoolBase which does not retain or recycle anything and will always simply construct and return new instance when acquireBufferRecycler is called
ThreadLocalPoolBase which uses ThreadLocal to retain at most 1 object per Thread.
BoundedPoolBase is "bounded pool" and retains at most N objects (default value being BoundedPoolBase#DEFAULT_CAPACITY) at any given time.
Two implementations -- ConcurrentDequePoolBase, LockFreePoolBase -- are "unbounded" and retain any number of objects released: in practice it is at most the highest number of concurrently used BufferRecyclers.

Default implementations are also included as nested classes.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	RecyclerPool.BoundedPoolBase<P extends RecyclerPool.WithPool<P>> `RecyclerPool` implementation that uses a bounded queue (`ArrayBlockingQueue` for recycling instances.
public abstract static class	RecyclerPool.ConcurrentDequePoolBase<P extends RecyclerPool.WithPool<P>> `RecyclerPool` implementation that uses `ConcurrentLinkedDeque` for recycling instances.
public abstract static class	RecyclerPool.LockFreePoolBase<P extends RecyclerPool.WithPool<P>> `RecyclerPool` implementation that uses a lock free linked list for recycling instances.
public abstract static class	RecyclerPool.NonRecyclingPoolBase<P extends RecyclerPool.WithPool<P>> `RecyclerPool` implementation that does not use any pool but simply creates new instances when necessary.
public abstract static class	RecyclerPool.StatefulImplBase<P extends RecyclerPool.WithPool<P>> Intermediate base class for instances that are stateful and require special handling with respect to JDK serialization, to retain "global" reference distinct from non-shared ones.
public abstract static class	RecyclerPool.ThreadLocalPoolBase<P extends RecyclerPool.WithPool<P>> Default `RecyclerPool` implementation that uses `ThreadLocal` for recycling instances.
public static interface	RecyclerPool.WithPool< Self type P extends RecyclerPool.WithPool<P>> Simple add-on interface that poolable entities must implement.

Method Summary

Modifier and Type	Method and Description
public default P	Returns: Pooled instance for caller to use; caller expected to call `releasePooled` after it is done using instance. acquireAndLinkPooled() Method called to acquire a Pooled value from this pool AND make sure it is linked back to this `RecyclerPool` as necessary for it to be released (see `releasePooled`) later after usage ends.
public P	Returns: Instance acquired (pooled or just constructed) acquirePooled() Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public void	releasePooled(P Pooled instance to release back to pool pooled) Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Method Detail

acquireAndLinkPooled back to summary

acquireAndLinkPooled	back to summary
public default P acquireAndLinkPooled() Method called to acquire a Pooled value from this pool AND make sure it is linked back to this `RecyclerPool` as necessary for it to be released (see `releasePooled`) later after usage ends. Actual acquisition is done by a call to `acquirePooled()`. Default implementation calls `acquirePooled()` followed by a call to `WithPool#withPool`. Returns:P Pooled instance for caller to use; caller expected to call `releasePooled` after it is done using instance.

public default P acquireAndLinkPooled()

Method called to acquire a Pooled value from this pool AND make sure it is linked back to this RecyclerPool as necessary for it to be released (see releasePooled) later after usage ends. Actual acquisition is done by a call to acquirePooled().

Default implementation calls acquirePooled() followed by a call to WithPool#withPool.

Returns:P: Pooled instance for caller to use; caller expected to call releasePooled after it is done using instance.

acquirePooled back to summary

acquirePooled	back to summary
public P acquirePooled() Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`. Returns:P Instance acquired (pooled or just constructed)

public P acquirePooled()

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P: Instance acquired (pooled or just constructed)

releasePooled back to summary

releasePooled	back to summary
public void releasePooled(P pooled) Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse. Parameters pooled:P Pooled instance to release back to pool

public void releasePooled(P pooled)

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.BoundedPoolBase>

Class Inheritance

extends RecyclerPool.StatefulImplBase>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase
com.fasterxml.jackson.core.util.RecyclerPool.BoundedPoolBase

Known Direct Subclasses

com.fasterxml.jackson.core.util.JsonRecyclerPools.BoundedPool

RecyclerPool implementation that uses a bounded queue (ArrayBlockingQueue for recycling instances. This is "bounded" pool since it will never hold on to more pooled instances than its size configuration: the default size is BoundedPoolBase#DEFAULT_CAPACITY.

Field Summary

Modifier and Type	Field and Description
private final transient int	capacity
public static final int	DEFAULT_CAPACITY Default capacity which limits number of items that are ever retained for reuse.
private final transient ArrayBlockingQueue<P>	pool
private static final long	serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _serialization SERIALIZATION_NON_SHARED SERIALIZATION_SHARED

Constructor Summary

Access	Constructor and Description
protected	BoundedPoolBase(int capacityAsId)

Method Summary

Modifier and Type	Method and Description
public P	acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public int	capacity()
public void	releasePooled(P Pooled instance to release back to pool pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _resolveToShared createPooled

Field Detail

capacity	back to summary
private final transient int capacity

DEFAULT_CAPACITY	back to summary
public static final int DEFAULT_CAPACITY Default capacity which limits number of items that are ever retained for reuse.

pool	back to summary
private final transient ArrayBlockingQueue<P> pool

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Constructor Detail

BoundedPoolBase	back to summary
protected BoundedPoolBase(int capacityAsId)

Method Detail

acquirePooled back to summary

acquirePooled	back to summary
public P acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`. Returns:P Instance acquired (pooled or just constructed) Annotations @Override

public P acquirePooled()

Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P

Instance acquired (pooled or just constructed)

Annotations

@Override

capacity	back to summary
public int capacity()

releasePooled back to summary

releasePooled	back to summary
public void releasePooled(P pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse. Parameters pooled:P Pooled instance to release back to pool Annotations @Override

public void releasePooled(P pooled)

Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

Annotations

@Override

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.ConcurrentDequePoolBase>

Class Inheritance

extends RecyclerPool.StatefulImplBase>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase
com.fasterxml.jackson.core.util.RecyclerPool.ConcurrentDequePoolBase

Known Direct Subclasses

com.fasterxml.jackson.core.util.JsonRecyclerPools.ConcurrentDequePool

RecyclerPool implementation that uses ConcurrentLinkedDeque for recycling instances.

Pool is unbounded: see RecyclerPool what this means.

Field Summary

Modifier and Type	Field and Description
protected final transient Deque<P>	pool
private static final long	serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _serialization SERIALIZATION_NON_SHARED SERIALIZATION_SHARED

Constructor Summary

Access	Constructor and Description
protected	ConcurrentDequePoolBase(int serialization)

Method Summary

Modifier and Type	Method and Description
public P	acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public void	releasePooled(P Pooled instance to release back to pool pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _resolveToShared createPooled

Field Detail

pool	back to summary
protected final transient Deque<P> pool

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Constructor Detail

ConcurrentDequePoolBase	back to summary
protected ConcurrentDequePoolBase(int serialization)

Method Detail

acquirePooled back to summary

acquirePooled	back to summary
public P acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`. Returns:P Instance acquired (pooled or just constructed) Annotations @Override

public P acquirePooled()

Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P

Instance acquired (pooled or just constructed)

Annotations

@Override

releasePooled back to summary

releasePooled	back to summary
public void releasePooled(P pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse. Parameters pooled:P Pooled instance to release back to pool Annotations @Override

public void releasePooled(P pooled)

Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

Annotations

@Override

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.LockFreePoolBase>

Class Inheritance

extends RecyclerPool.StatefulImplBase>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase
com.fasterxml.jackson.core.util.RecyclerPool.LockFreePoolBase

Known Direct Subclasses

com.fasterxml.jackson.core.util.JsonRecyclerPools.LockFreePool

RecyclerPool implementation that uses a lock free linked list for recycling instances. Pool is unbounded: see RecyclerPool for details on what this means.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static class	RecyclerPool.LockFreePoolBase.Node<P>

Field Summary

Modifier and Type	Field and Description
private final transient AtomicReference<RecyclerPool.LockFreePoolBase.Node<P>>	head
private static final long	serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _serialization SERIALIZATION_NON_SHARED SERIALIZATION_SHARED

Constructor Summary

Access	Constructor and Description
protected	LockFreePoolBase(int serialization)

Method Summary

Modifier and Type	Method and Description
public P	acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public void	releasePooled(P Pooled instance to release back to pool pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Inherited from com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase:: _resolveToShared createPooled

Field Detail

head	back to summary
private final transient AtomicReference<RecyclerPool.LockFreePoolBase.Node<P>> head

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase.serialVersionUID.

Constructor Detail

LockFreePoolBase	back to summary
protected LockFreePoolBase(int serialization)

Method Detail

acquirePooled back to summary

acquirePooled	back to summary
public P acquirePooled() Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`. Returns:P Instance acquired (pooled or just constructed) Annotations @Override

public P acquirePooled()

Implements com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P

Instance acquired (pooled or just constructed)

Annotations

@Override

releasePooled back to summary

releasePooled	back to summary
public void releasePooled(P pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse. Parameters pooled:P Pooled instance to release back to pool Annotations @Override

public void releasePooled(P pooled)

Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

Annotations

@Override

com.fasterxml.jackson.core.util back to summary

protected Class RecyclerPool.LockFreePoolBase.Node

Class Inheritance

extends Object

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.LockFreePoolBase.Node

Field Summary

Modifier and Type	Field and Description
pack-priv RecyclerPool.LockFreePoolBase.Node<P>	next
pack-priv final P	value

Constructor Summary

Access	Constructor and Description
pack-priv	Node(P value)

Method Summary

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

Field Detail

next	back to summary
pack-priv RecyclerPool.LockFreePoolBase.Node<P> next

value	back to summary
pack-priv final P value

Constructor Detail

Node	back to summary
pack-priv Node(P value)

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.NonRecyclingPoolBase>

Class Inheritance

extends Object
implements RecyclerPool>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.NonRecyclingPoolBase

All Implemented Interfaces

com.fasterxml.jackson.core.util.RecyclerPool, java.io.Serializable

Known Direct Subclasses

com.fasterxml.jackson.core.util.JsonRecyclerPools.NonRecyclingPool

RecyclerPool implementation that does not use any pool but simply creates new instances when necessary.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	NonRecyclingPoolBase()

Method Summary

Modifier and Type	Method and Description
public P	acquireAndLinkPooled() Overrides default com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled. Method called to acquire a Pooled value from this pool AND make sure it is linked back to this `RecyclerPool` as necessary for it to be released (see `releasePooled`) later after usage ends.
public abstract P	acquirePooled() Redeclares com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public void	releasePooled(P Pooled instance to release back to pool pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

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

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

NonRecyclingPoolBase	back to summary
public NonRecyclingPoolBase()

Method Detail

acquireAndLinkPooled back to summary

acquireAndLinkPooled	back to summary
public P acquireAndLinkPooled() Overrides default com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled. Method called to acquire a Pooled value from this pool AND make sure it is linked back to this `RecyclerPool` as necessary for it to be released (see `releasePooled`) later after usage ends. Actual acquisition is done by a call to `acquirePooled()`. Default implementation calls `acquirePooled()` followed by a call to `WithPool#withPool`. Returns:P Pooled instance for caller to use; caller expected to call `releasePooled` after it is done using instance. Annotations @Override

public P acquireAndLinkPooled()

Overrides default com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled.

Default implementation calls acquirePooled() followed by a call to WithPool#withPool.

Returns:P

Pooled instance for caller to use; caller expected to call releasePooled after it is done using instance.

Annotations

@Override

acquirePooled back to summary

acquirePooled	back to summary
public abstract P acquirePooled() Redeclares com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`. Returns:P Instance acquired (pooled or just constructed) Annotations @Override

public abstract P acquirePooled()

Redeclares com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P

Instance acquired (pooled or just constructed)

Annotations

@Override

releasePooled back to summary

releasePooled	back to summary
public void releasePooled(P pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse. Parameters pooled:P Pooled instance to release back to pool Annotations @Override

public void releasePooled(P pooled)

Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

Annotations

@Override

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.StatefulImplBase>

Class Inheritance

extends Object
implements RecyclerPool>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.StatefulImplBase

All Implemented Interfaces

com.fasterxml.jackson.core.util.RecyclerPool, java.io.Serializable

Known Direct Subclasses

com.fasterxml.jackson.core.util.RecyclerPool.ConcurrentDequePoolBase, com.fasterxml.jackson.core.util.RecyclerPool.LockFreePoolBase, com.fasterxml.jackson.core.util.RecyclerPool.BoundedPoolBase

Intermediate base class for instances that are stateful and require special handling with respect to JDK serialization, to retain "global" reference distinct from non-shared ones.

Field Summary

Modifier and Type	Field and Description
protected final int	_serialization Value that indicates basic aspects of pool for JDK serialization; either marker for shared/non-shared, or possibly bounded size; depends on sub-class.
public static final int	SERIALIZATION_NON_SHARED
public static final int	SERIALIZATION_SHARED
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
protected	StatefulImplBase(int serialization)

Method Summary

Modifier and Type	Method and Description
protected Optional<RecyclerPool.StatefulImplBase<P>>	_resolveToShared(RecyclerPool.StatefulImplBase<P> shared)
public abstract P	createPooled()

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

Field Detail

_serialization	back to summary
protected final int _serialization Value that indicates basic aspects of pool for JDK serialization; either marker for shared/non-shared, or possibly bounded size; depends on sub-class.

SERIALIZATION_NON_SHARED	back to summary
public static final int SERIALIZATION_NON_SHARED

SERIALIZATION_SHARED	back to summary
public static final int SERIALIZATION_SHARED

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

StatefulImplBase	back to summary
protected StatefulImplBase(int serialization)

Method Detail

_resolveToShared	back to summary
protected Optional<RecyclerPool.StatefulImplBase<P>> _resolveToShared(RecyclerPool.StatefulImplBase<P> shared)

createPooled	back to summary
public abstract P createPooled()

com.fasterxml.jackson.core.util back to summary

public abstract Class RecyclerPool.ThreadLocalPoolBase>

Class Inheritance

extends Object
implements RecyclerPool>

java.lang.Object
com.fasterxml.jackson.core.util.RecyclerPool.ThreadLocalPoolBase

All Implemented Interfaces

com.fasterxml.jackson.core.util.RecyclerPool, java.io.Serializable

Known Direct Subclasses

com.fasterxml.jackson.core.util.JsonRecyclerPools.ThreadLocalPool

Default RecyclerPool implementation that uses ThreadLocal for recycling instances. Instances are stored using java.lang.ref.SoftReferences so that they may be Garbage Collected as needed by JVM.

Note that this implementation may not work well on platforms where java.lang.ref.SoftReferences are not well supported (like Android), or on platforms where java.lang.Threads are not long-living or reused (like Project Loom).

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
protected	ThreadLocalPoolBase()

Method Summary

Modifier and Type	Method and Description
public P	acquireAndLinkPooled() Overrides default com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled. Method called to acquire a Pooled value from this pool AND make sure it is linked back to this `RecyclerPool` as necessary for it to be released (see `releasePooled`) later after usage ends.
public abstract P	acquirePooled() Redeclares com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled. Method for sub-classes to implement for actual acquire logic; called by `acquireAndLinkPooled()`.
public void	releasePooled(P Pooled instance to release back to pool pooled) Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled. Method that should be called when previously acquired (see `acquireAndLinkPooled`) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

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

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

ThreadLocalPoolBase	back to summary
protected ThreadLocalPoolBase()

Method Detail

acquireAndLinkPooled back to summary

public P acquireAndLinkPooled()

Overrides default com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquireAndLinkPooled.

Default implementation calls acquirePooled() followed by a call to WithPool#withPool.

Returns:P

Pooled instance for caller to use; caller expected to call releasePooled after it is done using instance.

Annotations

@Override

acquirePooled back to summary

public abstract P acquirePooled()

Redeclares com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.acquirePooled.

Method for sub-classes to implement for actual acquire logic; called by acquireAndLinkPooled().

Returns:P

Instance acquired (pooled or just constructed)

Annotations

@Override

releasePooled back to summary

public void releasePooled(P pooled)

Implements com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Doc from com.fasterxml.jackson.core.util.RecyclerPool.releasePooled.

Method that should be called when previously acquired (see acquireAndLinkPooled) pooled value that is no longer needed; this lets pool to take ownership for possible reuse.

Parameters

pooled:P: Pooled instance to release back to pool

Annotations

@Override

com.fasterxml.jackson.core.util back to summary

public Interface RecyclerPool.WithPool>

Known Direct Implementers

com.fasterxml.jackson.core.util.BufferRecycler

Type Parameters

: Self type

Simple add-on interface that poolable entities must implement.

Method Summary

Modifier and Type	Method and Description
public void	releaseToPool() Method called when this item is to be released back to the pool that owns it (if any)
public P	Returns: This item (for call chaining) withPool(RecyclerPool<P> Pool that "owns" pooled item pool) Method to call to add link from pooled item back to pool that handles it

Method Detail

releaseToPool	back to summary
public void releaseToPool() Method called when this item is to be released back to the pool that owns it (if any)

withPool

back to summary

public P withPool(RecyclerPool pool)

Method to call to add link from pooled item back to pool that handles it

Parameters

pool:RecyclerPool: Pool that "owns" pooled item

Returns:P

This item (for call chaining)

public Interface RecyclerPool<P extends RecyclerPool.WithPool<P>>

Nested and Inner Type Summary

Method Summary

Method Detail

public abstract Class RecyclerPool.BoundedPoolBase<P extends RecyclerPool.WithPool<P>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class RecyclerPool.ConcurrentDequePoolBase<P extends RecyclerPool.WithPool<P>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class RecyclerPool.LockFreePoolBase<P extends RecyclerPool.WithPool<P>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class RecyclerPool.LockFreePoolBase.Node<P>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public abstract Class RecyclerPool.NonRecyclingPoolBase<P extends RecyclerPool.WithPool<P>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class RecyclerPool.StatefulImplBase<P extends RecyclerPool.WithPool<P>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class RecyclerPool.ThreadLocalPoolBase<P extends RecyclerPool.WithPool<P>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface RecyclerPool.WithPool<P extends RecyclerPool.WithPool<P>>

Method Summary

Method Detail