Package com.fasterxml.jackson.core.util
Class TextBuffer
- java.lang.Object
-
- com.fasterxml.jackson.core.util.TextBuffer
-
public final class TextBuffer extends java.lang.Object
TextBuffer is a class similar toStringBuffer
, with following differences:- TextBuffer uses segments character arrays, to avoid having to do additional array copies when array is not big enough. This means that only reallocating that is necessary is done only once: if and when caller wants to access contents in a linear array (char[], String).
- TextBuffer can also be initialized in "shared mode", in which it will just act as a wrapper to a single char array managed by another object (like parser that owns it)
- TextBuffer is not synchronized.
-
-
Constructor Summary
Constructors Constructor Description TextBuffer(BufferRecycler allocator)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(char c)
void
append(char[] c, int start, int len)
void
append(java.lang.String str, int offset, int len)
char[]
contentsAsArray()
java.math.BigDecimal
contentsAsDecimal()
Convenience method for converting contents of the buffer into aBigDecimal
.double
contentsAsDouble()
Convenience method for converting contents of the buffer into a Double value.int
contentsAsInt(boolean neg)
Specialized convenience method that will decode a 32-bit int, of at most 9 digits (and possible leading minus sign).long
contentsAsLong(boolean neg)
Specialized convenience method that will decode a 64-bit int, of at most 18 digits (and possible leading minus sign).java.lang.String
contentsAsString()
Accessor that may be used to get the contents of this buffer as a singleString
regardless of whether they were collected in a segmented fashion or not: this typically require construction of the result String.int
contentsToWriter(java.io.Writer w)
Accessor that will write buffered contents using givenWriter
.char[]
emptyAndGetCurrentSegment()
void
ensureNotShared()
Method called to make sure that buffer is not using shared input buffer; if it is, it will copy such contents to private buffer.char[]
expandCurrentSegment()
Method called to expand size of the current segment, to accommodate for more contiguous content.char[]
expandCurrentSegment(int minSize)
Method called to expand size of the current segment, to accommodate for more contiguous content.char[]
finishCurrentSegment()
static TextBuffer
fromInitial(char[] initialSegment)
Factory method for constructing an instance with no allocator, and with initial full segment.char[]
getBufferWithoutReset()
Method for accessing the currently active (last) content segment without changing state of the bufferchar[]
getCurrentSegment()
int
getCurrentSegmentSize()
char[]
getTextBuffer()
Accessor that may be used to get the contents of this buffer as a singlechar[]
regardless of whether they were collected in a segmented fashion or not: this typically require allocation of the result buffer.int
getTextOffset()
boolean
hasTextAsCharacters()
Method that can be used to check whether textual contents can be efficiently accessed usinggetTextBuffer()
.void
releaseBuffers()
Method called to indicate that the underlying buffers should now be recycled if they haven't yet been recycled.void
resetWith(char ch)
Method for clearing out possibly existing content, and replacing them with a single-character content (sosize()
would return1
)void
resetWithCopy(char[] buf, int offset, int len)
void
resetWithCopy(java.lang.String text, int start, int len)
void
resetWithEmpty()
Method called to clear out any content text buffer may have, and initializes buffer to use non-shared data.void
resetWithShared(char[] buf, int offset, int len)
Method called to initialize the buffer with a shared copy of data; this means that buffer will just have pointers to actual data.void
resetWithString(java.lang.String value)
java.lang.String
setCurrentAndReturn(int len)
Convenience method that finishes the current active content segment (by specifying how many characters within consists of valid content) and aggregates and returns resulting contents (similar to a call tocontentsAsString()
).void
setCurrentLength(int len)
int
size()
java.lang.String
toString()
Note: calling this method may not be as efficient as callingcontentsAsString()
, since it's not guaranteed that resulting String is cached.
-
-
-
Constructor Detail
-
TextBuffer
public TextBuffer(BufferRecycler allocator)
-
-
Method Detail
-
fromInitial
public static TextBuffer fromInitial(char[] initialSegment)
Factory method for constructing an instance with no allocator, and with initial full segment.- Parameters:
initialSegment
- Initial, full segment to use for creating buffer (buffersize()
would return length ofinitialSegment
)- Returns:
- TextBuffer constructed
- Since:
- 2.10
-
releaseBuffers
public void releaseBuffers()
Method called to indicate that the underlying buffers should now be recycled if they haven't yet been recycled. Although caller can still use this text buffer, it is not advisable to call this method if that is likely, since next time a buffer is needed, buffers need to reallocated.Note: since Jackson 2.11, calling this method will NOT clear already aggregated contents (that is,
_currentSegment
, to retain current token text if (but only if!) already aggregated.
-
resetWithEmpty
public void resetWithEmpty()
Method called to clear out any content text buffer may have, and initializes buffer to use non-shared data.
-
resetWith
public void resetWith(char ch)
Method for clearing out possibly existing content, and replacing them with a single-character content (sosize()
would return1
)- Parameters:
ch
- Character to set as the buffer contents- Since:
- 2.9
-
resetWithShared
public void resetWithShared(char[] buf, int offset, int len)
Method called to initialize the buffer with a shared copy of data; this means that buffer will just have pointers to actual data. It also means that if anything is to be appended to the buffer, it will first have to unshare it (make a local copy).- Parameters:
buf
- Buffer that contains shared contentsoffset
- Offset of the first content character inbuf
len
- Length of content inbuf
-
resetWithCopy
public void resetWithCopy(char[] buf, int offset, int len)
-
resetWithCopy
public void resetWithCopy(java.lang.String text, int start, int len)
-
resetWithString
public void resetWithString(java.lang.String value)
-
getBufferWithoutReset
public char[] getBufferWithoutReset()
Method for accessing the currently active (last) content segment without changing state of the buffer- Returns:
- Currently active (last) content segment
- Since:
- 2.9
-
size
public int size()
- Returns:
- Number of characters currently stored in this buffer
-
getTextOffset
public int getTextOffset()
-
hasTextAsCharacters
public boolean hasTextAsCharacters()
Method that can be used to check whether textual contents can be efficiently accessed usinggetTextBuffer()
.- Returns:
True
if access viagetTextBuffer()
would be efficient (that is, content already available as aggregatedchar[]
)
-
getTextBuffer
public char[] getTextBuffer()
Accessor that may be used to get the contents of this buffer as a singlechar[]
regardless of whether they were collected in a segmented fashion or not: this typically require allocation of the result buffer.- Returns:
- Aggregated
char[]
that contains all buffered content
-
contentsAsString
public java.lang.String contentsAsString()
Accessor that may be used to get the contents of this buffer as a singleString
regardless of whether they were collected in a segmented fashion or not: this typically require construction of the result String.- Returns:
- Aggregated buffered contents as a
String
-
contentsAsArray
public char[] contentsAsArray()
-
contentsAsDecimal
public java.math.BigDecimal contentsAsDecimal() throws java.lang.NumberFormatException
Convenience method for converting contents of the buffer into aBigDecimal
.- Returns:
- Buffered text value parsed as a
BigDecimal
, if possible - Throws:
java.lang.NumberFormatException
- if contents are not a valid Java number
-
contentsAsDouble
public double contentsAsDouble() throws java.lang.NumberFormatException
Convenience method for converting contents of the buffer into a Double value.- Returns:
- Buffered text value parsed as a
Double
, if possible - Throws:
java.lang.NumberFormatException
- if contents are not a valid Java number
-
contentsAsInt
public int contentsAsInt(boolean neg)
Specialized convenience method that will decode a 32-bit int, of at most 9 digits (and possible leading minus sign).NOTE: method DOES NOT verify that the contents actually are a valid Java
int
value (either regarding format, or value range): caller MUST validate that.- Parameters:
neg
- Whether contents start with a minus sign- Returns:
- Buffered text value parsed as an
int
usingNumberInput.parseInt(String)
method (which does NOT validate input) - Since:
- 2.9
-
contentsAsLong
public long contentsAsLong(boolean neg)
Specialized convenience method that will decode a 64-bit int, of at most 18 digits (and possible leading minus sign).NOTE: method DOES NOT verify that the contents actually are a valid Java
long
value (either regarding format, or value range): caller MUST validate that.- Parameters:
neg
- Whether contents start with a minus sign- Returns:
- Buffered text value parsed as an
long
usingNumberInput.parseLong(String)
method (which does NOT validate input) - Since:
- 2.9
-
contentsToWriter
public int contentsToWriter(java.io.Writer w) throws java.io.IOException
Accessor that will write buffered contents using givenWriter
.- Parameters:
w
- Writer to use for writing out buffered content- Returns:
- Number of characters written (same as
size()
) - Throws:
java.io.IOException
- If write usingWriter
parameter fails- Since:
- 2.8
-
ensureNotShared
public void ensureNotShared()
Method called to make sure that buffer is not using shared input buffer; if it is, it will copy such contents to private buffer.
-
append
public void append(char c)
-
append
public void append(char[] c, int start, int len)
-
append
public void append(java.lang.String str, int offset, int len)
-
getCurrentSegment
public char[] getCurrentSegment()
-
emptyAndGetCurrentSegment
public char[] emptyAndGetCurrentSegment()
-
getCurrentSegmentSize
public int getCurrentSegmentSize()
-
setCurrentLength
public void setCurrentLength(int len)
-
setCurrentAndReturn
public java.lang.String setCurrentAndReturn(int len)
Convenience method that finishes the current active content segment (by specifying how many characters within consists of valid content) and aggregates and returns resulting contents (similar to a call tocontentsAsString()
).- Parameters:
len
- Length of content (in characters) of the current active segment- Returns:
- String that contains all buffered content
- Since:
- 2.6
-
finishCurrentSegment
public char[] finishCurrentSegment()
-
expandCurrentSegment
public char[] expandCurrentSegment()
Method called to expand size of the current segment, to accommodate for more contiguous content. Usually only used when parsing tokens like names if even then. Method will both expand the segment and return it- Returns:
- Expanded current segment
-
expandCurrentSegment
public char[] expandCurrentSegment(int minSize)
Method called to expand size of the current segment, to accommodate for more contiguous content. Usually only used when parsing tokens like names if even then.- Parameters:
minSize
- Required minimum strength of the current segment- Returns:
- Expanded current segment
- Since:
- 2.4
-
toString
public java.lang.String toString()
Note: calling this method may not be as efficient as callingcontentsAsString()
, since it's not guaranteed that resulting String is cached.- Overrides:
toString
in classjava.lang.Object
-
-