Skip to content

Fix #1114: make BufferRecyclerPool generic #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 28, 2023
Merged

Fix #1114: make BufferRecyclerPool generic #1115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
775a504
Start skeletal version of changes
cowtowncoder Sep 26, 2023
dec745a
Convert ThreadLocal-based pool to parameterized version
cowtowncoder Sep 27, 2023
b28f9c3
Convert second pool implementation (non-recycling)
cowtowncoder Sep 27, 2023
64276f3
DequePool converted too
cowtowncoder Sep 27, 2023
58edb25
Major refactoring/renaming
cowtowncoder Sep 28, 2023
3ff604a
Convert last pool instance to base/impl set up
cowtowncoder Sep 28, 2023
eae65fa
Mark BufferRecyclers as deprecated
cowtowncoder Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/main/java/com/fasterxml/jackson/core/JsonFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public static int collectDefaults() {
/**
* @since 2.16
*/
protected BufferRecyclerPool _bufferRecyclerPool;
protected BufferRecyclerPool<BufferRecycler> _bufferRecyclerPool;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will probably consider renaming of BufferRecyclerPool as it'll allow recycling other things, but initially leaving name as-is to simplify merging to master.


/**
* Object that implements conversion functionality between
Expand Down Expand Up @@ -368,7 +368,7 @@ public static int collectDefaults() {
public JsonFactory() { this((ObjectCodec) null); }

public JsonFactory(ObjectCodec oc) {
_bufferRecyclerPool = BufferRecyclerPool.defaultPool();
_bufferRecyclerPool = JsonBufferRecyclers.defaultPool();
_objectCodec = oc;
_quoteChar = DEFAULT_QUOTE_CHAR;
_streamReadConstraints = StreamReadConstraints.defaults();
Expand Down Expand Up @@ -1152,7 +1152,7 @@ public String getRootValueSeparator() {
/**********************************************************
*/

public JsonFactory setBufferRecyclerPool(BufferRecyclerPool p) {
public JsonFactory setBufferRecyclerPool(BufferRecyclerPool<BufferRecycler> p) {
_bufferRecyclerPool = Objects.requireNonNull(p);
return this;
}
Expand Down Expand Up @@ -2150,7 +2150,7 @@ protected JsonGenerator _decorate(JsonGenerator g) {
*/
public BufferRecycler _getBufferRecycler()
{
return _getBufferRecyclerPool().acquireAndLinkBufferRecycler();
return _getBufferRecyclerPool().acquireAndLinkPooled();
}

/**
Expand All @@ -2159,12 +2159,12 @@ public BufferRecycler _getBufferRecycler()
*
* @since 2.16
*/
public BufferRecyclerPool _getBufferRecyclerPool() {
public BufferRecyclerPool<BufferRecycler> _getBufferRecyclerPool() {
// 23-Apr-2015, tatu: Let's allow disabling of buffer recycling
// scheme, for cases where it is considered harmful (possibly
// on Android, for example)
if (!Feature.USE_THREAD_LOCAL_FOR_BUFFER_RECYCLING.enabledIn(_factoryFeatures)) {
return BufferRecyclerPool.nonRecyclingPool();
return JsonBufferRecyclers.nonRecyclingPool();
}
return _bufferRecyclerPool;
}
Expand Down
10 changes: 6 additions & 4 deletions src/main/java/com/fasterxml/jackson/core/TSFBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
import com.fasterxml.jackson.core.io.OutputDecorator;
import com.fasterxml.jackson.core.json.JsonReadFeature;
import com.fasterxml.jackson.core.json.JsonWriteFeature;
import com.fasterxml.jackson.core.util.BufferRecycler;
import com.fasterxml.jackson.core.util.BufferRecyclerPool;
import com.fasterxml.jackson.core.util.JsonBufferRecyclers;
import com.fasterxml.jackson.core.util.JsonGeneratorDecorator;

/**
Expand Down Expand Up @@ -74,7 +76,7 @@ public abstract class TSFBuilder<F extends JsonFactory,
/**
* @since 2.16
*/
protected BufferRecyclerPool _bufferRecyclerPool;
protected BufferRecyclerPool<BufferRecycler> _bufferRecyclerPool;

/**
* Optional helper object that may decorate input sources, to do
Expand Down Expand Up @@ -141,7 +143,7 @@ protected TSFBuilder(JsonFactory base)
protected TSFBuilder(int factoryFeatures,
int parserFeatures, int generatorFeatures)
{
_bufferRecyclerPool = BufferRecyclerPool.defaultPool();
_bufferRecyclerPool = JsonBufferRecyclers.defaultPool();

_factoryFeatures = factoryFeatures;
_streamReadFeatures = parserFeatures;
Expand Down Expand Up @@ -169,7 +171,7 @@ protected static <T> List<T> _copy(List<T> src) {
public int streamReadFeatures() { return _streamReadFeatures; }
public int streamWriteFeatures() { return _streamWriteFeatures; }

public BufferRecyclerPool bufferRecyclerPool() {
public BufferRecyclerPool<BufferRecycler> bufferRecyclerPool() {
return _bufferRecyclerPool;
}

Expand Down Expand Up @@ -321,7 +323,7 @@ public B configure(JsonWriteFeature f, boolean state) {
*
* @since 2.16
*/
public B bufferRecyclerPool(BufferRecyclerPool p) {
public B bufferRecyclerPool(BufferRecyclerPool<BufferRecycler> p) {
_bufferRecyclerPool = Objects.requireNonNull(p);
return _this();
}
Expand Down
10 changes: 6 additions & 4 deletions src/main/java/com/fasterxml/jackson/core/util/BufferRecycler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* Rewritten in 2.16 to work with {@link BufferRecyclerPool} abstraction.
*/
public class BufferRecycler
implements BufferRecyclerPool.WithPool<BufferRecycler>
{
/**
* Buffer used for reading byte-based input.
Expand Down Expand Up @@ -86,7 +87,7 @@ public class BufferRecycler
// Note: changed from simple array in 2.10:
protected final AtomicReferenceArray<char[]> _charBuffers;

private BufferRecyclerPool _pool;
private BufferRecyclerPool<BufferRecycler> _pool;

/*
/**********************************************************
Expand Down Expand Up @@ -202,7 +203,8 @@ protected int charBufferLength(int ix) {
*
* @since 2.16
*/
BufferRecycler withPool(BufferRecyclerPool pool) {
@Override
public BufferRecycler withPool(BufferRecyclerPool<BufferRecycler> pool) {
if (this._pool != null) {
throw new IllegalStateException("BufferRecycler already linked to pool: "+pool);
}
Expand All @@ -220,11 +222,11 @@ BufferRecycler withPool(BufferRecyclerPool pool) {
*/
public void release() {
if (_pool != null) {
BufferRecyclerPool tmpPool = _pool;
BufferRecyclerPool<BufferRecycler> tmpPool = _pool;
// nullify the reference to the pool in order to avoid the risk of releasing
// the same BufferRecycler more than once, thus compromising the pool integrity
_pool = null;
tmpPool.releaseBufferRecycler(this);
tmpPool.releasePooled(this);
}
}
}
Loading