Class TextBuffer


  • public final class TextBuffer
    extends Object
    TextBuffer is a class similar to StringBuffer, 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 Detail

    • Method Detail

      • fromInitial

        public static TextBuffer fromInitial​(char[] initialSegment)
        Factory method for constructing an instance with no allocator, and with initial full segment.
        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)
        Since:
        2.9
      • resetWithShared

        public void resetWithShared​(char[] buf,
                                    int start,
                                    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).
      • resetWithCopy

        public void resetWithCopy​(char[] buf,
                                  int start,
                                  int len)
      • resetWithCopy

        public void resetWithCopy​(String text,
                                  int start,
                                  int len)
        Since:
        2.9
      • resetWithString

        public void resetWithString​(String value)
      • getBufferWithoutReset

        public char[] getBufferWithoutReset()
        Since:
        2.9
      • size

        public int size()
        Returns:
        Number of characters currently stored by this collector
      • getTextOffset

        public int getTextOffset()
      • hasTextAsCharacters

        public boolean hasTextAsCharacters()
        Method that can be used to check whether textual contents can be efficiently accessed using getTextBuffer().
      • getTextBuffer

        public char[] getTextBuffer()
        Accessor that may be used to get the contents of this buffer in a single char array regardless of whether they were collected in a segmented fashion or not.
      • contentsAsString

        public String contentsAsString()
      • contentsAsArray

        public char[] contentsAsArray()
      • 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).
        Parameters:
        neg - Whether contents start with a minus sign
        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).
        Parameters:
        neg - Whether contents start with a minus sign
        Since:
        2.9
      • 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​(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 String setCurrentAndReturn​(int len)
        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.
      • 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
        Since:
        2.4.0
      • toString

        public String toString()
        Note: calling this method may not be as efficient as calling contentsAsString(), since it's not guaranteed that resulting String is cached.
        Overrides:
        toString in class Object