com.algolia.search.com.fasterxml.jackson.core.util.BufferRecyclers Maven / Gradle / Ivy
package com.fasterxml.jackson.core.util;
import java.lang.ref.SoftReference;
import com.fasterxml.jackson.core.io.JsonStringEncoder;
/**
* Helper entity used to control access to simple buffer recyling scheme used for
* some encoding, decoding tasks.
*
* @see BufferRecycler
* @see JsonStringEncoder
*
* @since 2.9.2
*/
public class BufferRecyclers
{
/**
* System property that is checked to see if recycled buffers (see {@link BufferRecycler})
* should be tracked, for purpose of forcing release of all such buffers, typically
* during major classloading.
*
* @since 2.9.6
*/
public final static String SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS
= "com.fasterxml.jackson.core.util.BufferRecyclers.trackReusableBuffers";
/*
/**********************************************************
/* Life-cycle
/**********************************************************
*/
/**
* Flag that indicates whether {@link BufferRecycler} instances should be tracked.
*/
private final static ThreadLocalBufferManager _bufferRecyclerTracker;
static {
_bufferRecyclerTracker = "true".equals(System.getProperty(SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS))
? ThreadLocalBufferManager.instance()
: null;
}
/*
/**********************************************************
/* BufferRecyclers for parsers, generators
/**********************************************************
*/
/**
* This ThreadLocal
contains a {@link java.lang.ref.SoftReference}
* to a {@link BufferRecycler} used to provide a low-cost
* buffer recycling between reader and writer instances.
*/
final protected static ThreadLocal> _recyclerRef
= new ThreadLocal>();
/**
* Main accessor to call for accessing possibly recycled {@link BufferRecycler} instance.
*/
public static BufferRecycler getBufferRecycler()
{
SoftReference ref = _recyclerRef.get();
BufferRecycler br = (ref == null) ? null : ref.get();
if (br == null) {
br = new BufferRecycler();
if (_bufferRecyclerTracker != null) {
ref = _bufferRecyclerTracker.wrapAndTrack(br);
} else {
ref = new SoftReference(br);
}
_recyclerRef.set(ref);
}
return br;
}
/**
* Specialized method that will release all recycled {@link BufferRecycler} if
* (and only if) recycler tracking has been enabled
* (see {@link #SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS}).
* This method is usually called on shutdown of the container like Application Server
* to ensure that no references are reachable via {@link ThreadLocal}s as this may cause
* unintentional retention of sizable amounts of memory. It may also be called regularly
* if GC for some reason does not clear up {@link SoftReference}s aggressively enough.
*
* @return Number of buffers released, if tracking enabled (zero or more); -1 if tracking not enabled.
*
* @since 2.9.6
*/
public static int releaseBuffers() {
if (_bufferRecyclerTracker != null) {
return _bufferRecyclerTracker.releaseBuffers();
}
return -1;
}
/*
/**********************************************************
/* JsonStringEncoder
/**********************************************************
*/
/**
* This ThreadLocal
contains a {@link java.lang.ref.SoftReference}
* to a {@link BufferRecycler} used to provide a low-cost
* buffer recycling between reader and writer instances.
*/
final protected static ThreadLocal> _encoderRef
= new ThreadLocal>();
public static JsonStringEncoder getJsonStringEncoder() {
SoftReference ref = _encoderRef.get();
JsonStringEncoder enc = (ref == null) ? null : ref.get();
if (enc == null) {
enc = new JsonStringEncoder();
_encoderRef.set(new SoftReference(enc));
}
return enc;
}
/**
* Helper method for encoding given String as UTF-8 encoded
*
* @since 2.9.4
*/
public static byte[] encodeAsUTF8(String text) {
return getJsonStringEncoder().encodeAsUTF8(text);
}
/**
* @since 2.9.4
*/
public static char[] quoteAsJsonText(String rawText) {
return getJsonStringEncoder().quoteAsString(rawText);
}
/**
* @since 2.9.4
*/
public static void quoteAsJsonText(CharSequence input, StringBuilder output) {
getJsonStringEncoder().quoteAsString(input, output);
}
/**
* @since 2.9.4
*/
public static byte[] quoteAsJsonUTF8(String rawText) {
return getJsonStringEncoder().quoteAsUTF8(rawText);
}
}