Jackson-core 2.16.0 · com.fasterxml.jackson.core.util.BufferRecyclers

Field Summary

Modifier and Type	Field and Description
private static final ThreadLocalBufferManager	_bufferRecyclerTracker Flag that indicates whether `BufferRecycler` instances should be tracked.
protected static final ThreadLocal<SoftReference<BufferRecycler>>	_recyclerRef This `ThreadLocal` contains a `java.lang.ref.SoftReference` to a `BufferRecycler` used to provide a low-cost buffer recycling between reader and writer instances.
public static final String	SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS System property that is checked to see if recycled buffers (see `BufferRecycler`) should be tracked, for purpose of forcing release of all such buffers, typically during major garbage-collection.

Constructor Summary

Access	Constructor and Description
public	BufferRecyclers()

Method Summary

Modifier and Type	Method and Description
public static byte[]	Returns: String encoded as UTF-8 bytes. encodeAsUTF8(String String to encode text) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `encodeAsUTF8()`) instead. Not to be used any more.
public static BufferRecycler	Returns: `BufferRecycler` to use getBufferRecycler() Deprecated Since 2.16 should use `RecyclerPool` abstraction instead of calling static methods of this class Main accessor to call for accessing possibly recycled `BufferRecycler` instance.
public static JsonStringEncoder	Returns: `JsonStringEncoder` instance to use. getJsonStringEncoder() Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` instead. Not to be used any more.
public static char[]	Returns: Quoted text as `char[]` quoteAsJsonText(String String to quote rawText) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `quoteAsString()`) instead. Not to be used any more:
public static void	quoteAsJsonText(CharSequence Textual content to quote input, StringBuilder Builder to append quoted content output) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `quoteAsString()`) instead. Not to be used any more.
public static byte[]	Returns: Quoted text as `byte[]` quoteAsJsonUTF8(String String to quote rawText) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` (and then `quoteAsUTF8()`) instead. Not to be used any more.
public static int	Returns: Number of buffers released, if tracking enabled (zero or more); -1 if tracking not enabled. releaseBuffers() Specialized method that will release all recycled `BufferRecycler` if (and only if) recycler tracking has been enabled (see `SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS`).

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

Field Detail

_bufferRecyclerTracker	back to summary
private static final ThreadLocalBufferManager _bufferRecyclerTracker Flag that indicates whether `BufferRecycler` instances should be tracked.

_recyclerRef	back to summary
protected static final ThreadLocal<SoftReference<BufferRecycler>> _recyclerRef This `ThreadLocal` contains a `java.lang.ref.SoftReference` to a `BufferRecycler` used to provide a low-cost buffer recycling between reader and writer instances.

SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS back to summary

SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS	back to summary
public static final String SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS System property that is checked to see if recycled buffers (see `BufferRecycler`) should be tracked, for purpose of forcing release of all such buffers, typically during major garbage-collection. Since 2.9.6

public static final String SYSTEM_PROPERTY_TRACK_REUSABLE_BUFFERS

System property that is checked to see if recycled buffers (see BufferRecycler) should be tracked, for purpose of forcing release of all such buffers, typically during major garbage-collection.

Since: 2.9.6

Constructor Detail

BufferRecyclers	back to summary
public BufferRecyclers()

Method Detail

encodeAsUTF8 back to summary

encodeAsUTF8	back to summary
public static byte[] encodeAsUTF8(String text) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `encodeAsUTF8()`) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0) Not to be used any more. Parameters text:String String to encode Returns:byte[] String encoded as UTF-8 bytes. Annotations @Deprecated

public static byte[] encodeAsUTF8(String text)

Deprecated

Since 2.10 call JsonStringEncoder#getInstance() and then encodeAsUTF8()) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0)

Not to be used any more.

Parameters

text:String: String to encode

Returns:byte[]

String encoded as UTF-8 bytes.

Annotations

@Deprecated

getBufferRecycler back to summary

getBufferRecycler	back to summary
public static BufferRecycler getBufferRecycler() Deprecated Since 2.16 should use `RecyclerPool` abstraction instead of calling static methods of this class Main accessor to call for accessing possibly recycled `BufferRecycler` instance. Returns:BufferRecycler `BufferRecycler` to use Annotations @Deprecated

public static BufferRecycler getBufferRecycler()

Deprecated

Since 2.16 should use RecyclerPool abstraction instead of calling static methods of this class

Main accessor to call for accessing possibly recycled BufferRecycler instance.

Returns:BufferRecycler

BufferRecycler to use

Annotations

@Deprecated

getJsonStringEncoder back to summary

getJsonStringEncoder	back to summary
public static JsonStringEncoder getJsonStringEncoder() Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0) Not to be used any more. Returns:JsonStringEncoder `JsonStringEncoder` instance to use. Annotations @Deprecated

public static JsonStringEncoder getJsonStringEncoder()

Deprecated

Since 2.10 call JsonStringEncoder#getInstance() instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0)

Not to be used any more.

Returns:JsonStringEncoder

JsonStringEncoder instance to use.

Annotations

@Deprecated

quoteAsJsonText back to summary

quoteAsJsonText	back to summary
public static char[] quoteAsJsonText(String rawText) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `quoteAsString()`) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0) Not to be used any more: Parameters rawText:String String to quote Returns:char[] Quoted text as `char[]` Annotations @Deprecated

public static char[] quoteAsJsonText(String rawText)

Deprecated

Since 2.10 call JsonStringEncoder#getInstance() and then quoteAsString()) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0)

Not to be used any more:

Parameters

rawText:String: String to quote

Returns:char[]

Quoted text as char[]

Annotations

@Deprecated

quoteAsJsonText back to summary

quoteAsJsonText	back to summary
public static void quoteAsJsonText(CharSequence input, StringBuilder output) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` and then `quoteAsString()`) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0) Not to be used any more. Parameters input:CharSequence Textual content to quote output:StringBuilder Builder to append quoted content Annotations @Deprecated

public static void quoteAsJsonText(CharSequence input, StringBuilder output)

Deprecated

Since 2.10 call JsonStringEncoder#getInstance() and then quoteAsString()) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0)

Not to be used any more.

Parameters

input:CharSequence: Textual content to quote
output:StringBuilder: Builder to append quoted content

Annotations

@Deprecated

quoteAsJsonUTF8 back to summary

quoteAsJsonUTF8	back to summary
public static byte[] quoteAsJsonUTF8(String rawText) Deprecated Since 2.10 call `JsonStringEncoder#getInstance()` (and then `quoteAsUTF8()`) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0) Not to be used any more. Parameters rawText:String String to quote Returns:byte[] Quoted text as `byte[]` Annotations @Deprecated

public static byte[] quoteAsJsonUTF8(String rawText)

Deprecated

Since 2.10 call JsonStringEncoder#getInstance() (and then quoteAsUTF8()) instead. NOTE: was accidentally removed but reintroduced as deprecated in 2.12.5, to be removed from 3.0)

Not to be used any more.

Parameters

rawText:String: String to quote

Returns:byte[]

Quoted text as byte[]

Annotations

@Deprecated

releaseBuffers back to summary

releaseBuffers	back to summary
public static int releaseBuffers() Specialized method that will release all recycled `BufferRecycler` if (and only if) recycler tracking has been enabled (see `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 `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 `SoftReference`s aggressively enough. Returns:int Number of buffers released, if tracking enabled (zero or more); -1 if tracking not enabled. Since 2.9.6

public static int releaseBuffers()

Specialized method that will release all recycled BufferRecycler if (and only if) recycler tracking has been enabled (see 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 ThreadLocals 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 SoftReferences aggressively enough.

Returns:int: Number of buffers released, if tracking enabled (zero or more); -1 if tracking not enabled.
Since: 2.9.6

public Class BufferRecyclers

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail