aalto-xml 1.3.2 · com.fasterxml.aalto.util.TextBuilder

Field Summary

Modifier and Type	Field and Description
private final ReaderConfig	_config
private char[]	_currentSegment
private int	_currentSize Number of characters in currently active (last) segment
private char[]	_decodeBuffer
private int	_decodeEnd
private int	_decodePtr
private boolean	_isIndentation Marker to know if the contents currently stored were created using "indentation detection".
private char[]	_resultArray
private int	_resultLen Indicator for length of data with `_resultArray`, iff the primary indicator (_currentSize) is invalid (-1).
private String	_resultString String that will be constructed when the whole contents are needed; will be temporarily stored in case asked for again.
private ArrayList<char[]>	_segments List of segments prior to currently active segment.
private int	_segmentSize Amount of characters in segments in `_segments`
pack-priv static final int	DEF_INITIAL_BUFFER_SIZE Size of the first text segment buffer to allocate.
pack-priv static final int	INT_SPACE
public static final int	MAX_INDENT_SPACES
public static final int	MAX_INDENT_TABS
pack-priv static final int	MAX_SEGMENT_LENGTH
private static final String	sIndSpaces
private static final char[]	sIndSpacesArray
private static final String[]	sIndSpacesStrings
private static final String	sIndTabs
private static final char[]	sIndTabsArray
private static final String[]	sIndTabsStrings
pack-priv static final char[]	sNoChars

Constructor Summary

Access	Constructor and Description
private	TextBuilder(ReaderConfig cfg)

Method Summary

Modifier and Type	Method and Description
private final char[]	allocBuffer(int minNeeded)
public void	append(char c)
public void	append(char[] c, int start, int len)
public void	append(String str)
public void	appendSurrogate(int surr)
private char[]	buildResultArray()
private int	calcNewSize(int latestSize)
public char[]	contentsAsArray()
public String	contentsAsString()
public int	contentsToArray(int srcStart, char[] dst, int dstStart, int len)
public static TextBuilder	createRecyclableBuffer(ReaderConfig cfg)
public int	decodeElements(TypedArrayDecoder tad, boolean reset) Method called by the stream reader to decode space-separated tokens that are part of the current text event (contents of which are stored within this buffer), using given decoder.
public boolean	equalsString(String str) Note it is assumed that this method is not used often enough to be a bottleneck, or for long segments.
private void	expand(int roomNeeded) Method called when current segment is full, to allocate new segment.
public char[]	finishCurrentSegment()
public void	fireSaxCharacterEvents(ContentHandler h) This is a specialized "accessor" method, which is basically to fire SAX characters() events in an optimal way, based on which internal buffers are being used
public void	fireSaxCommentEvent(LexicalHandler h)
public void	fireSaxSpaceEvents(ContentHandler h)
public char[]	getBufferWithoutReset()
public int	getCurrentLength()
public char[]	getTextBuffer()
public boolean	isAllWhitespace()
public int	rawContentsTo(Writer w) Method that will stream contents of this buffer into specified Writer.
public void	recycle(boolean force) Method called to indicate that the underlying buffers should now be recycled if they haven't yet been recycled.
public void	resetForBinaryDecode(Base64Variant v, CharArrayBase64Decoder dec, boolean firstChunk) Method called to initialize given base64 decoder with data contained in this text buffer (for the current event).
private final void	resetForDecode()
public void	resetWithChar(char c) Method called to initialize the buffer with just a single char
public char[]	resetWithEmpty() Method called to clear out any content text buffer may have, and initializes and returns the first segment to add characters to.
public void	resetWithIndentation(int indCharCount, char indChar)
public void	resetWithSurrogate(int c)
public void	setCurrentLength(int len)
public int	Returns: Number of characters currently stored by this collector size()
public String	toString() Overrides java.lang.Object.toString. Note calling this method may not be as efficient as calling `contentsAsString`, since it is guaranteed that resulting String is NOT cached (to ensure we see no stale data)

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

Field Detail

_config	back to summary
private final ReaderConfig _config

_currentSegment	back to summary
private char[] _currentSegment

_currentSize	back to summary
private int _currentSize Number of characters in currently active (last) segment

_decodeBuffer	back to summary
private char[] _decodeBuffer

_decodeEnd	back to summary
private int _decodeEnd

_decodePtr	back to summary
private int _decodePtr

_isIndentation	back to summary
private boolean _isIndentation Marker to know if the contents currently stored were created using "indentation detection". If so, it's known to be all white space

_resultArray	back to summary
private char[] _resultArray

_resultLen	back to summary
private int _resultLen Indicator for length of data with `_resultArray`, iff the primary indicator (_currentSize) is invalid (-1).

_resultString	back to summary
private String _resultString String that will be constructed when the whole contents are needed; will be temporarily stored in case asked for again.

_segments	back to summary
private ArrayList<char[]> _segments List of segments prior to currently active segment.

_segmentSize	back to summary
private int _segmentSize Amount of characters in segments in `_segments`

DEF_INITIAL_BUFFER_SIZE	back to summary
pack-priv static final int DEF_INITIAL_BUFFER_SIZE Size of the first text segment buffer to allocate. Need not contain the biggest segment, since new ones will get allocated as needed. However, it's sensible to use something that often is big enough to contain typical segments.

INT_SPACE	back to summary
pack-priv static final int INT_SPACE

MAX_INDENT_SPACES	back to summary
public static final int MAX_INDENT_SPACES

MAX_INDENT_TABS	back to summary
public static final int MAX_INDENT_TABS

MAX_SEGMENT_LENGTH	back to summary
pack-priv static final int MAX_SEGMENT_LENGTH

sIndSpaces	back to summary
private static final String sIndSpaces

sIndSpacesArray	back to summary
private static final char[] sIndSpacesArray

sIndSpacesStrings	back to summary
private static final String[] sIndSpacesStrings

sIndTabs	back to summary
private static final String sIndTabs

sIndTabsArray	back to summary
private static final char[] sIndTabsArray

sIndTabsStrings	back to summary
private static final String[] sIndTabsStrings

sNoChars	back to summary
pack-priv static final char[] sNoChars

Constructor Detail

TextBuilder	back to summary
private TextBuilder(ReaderConfig cfg)

Method Detail

allocBuffer	back to summary
private final char[] allocBuffer(int minNeeded)

append	back to summary
public void append(char c)

append	back to summary
public void append(char[] c, int start, int len)

append	back to summary
public void append(String str)

appendSurrogate	back to summary
public void appendSurrogate(int surr)

buildResultArray	back to summary
private char[] buildResultArray()

calcNewSize	back to summary
private int calcNewSize(int latestSize)

contentsAsArray	back to summary
public char[] contentsAsArray()

contentsAsString	back to summary
public String contentsAsString()

contentsToArray	back to summary
public int contentsToArray(int srcStart, char[] dst, int dstStart, int len)

createRecyclableBuffer	back to summary
public static TextBuilder createRecyclableBuffer(ReaderConfig cfg)

decodeElements	back to summary
public int decodeElements(TypedArrayDecoder tad, boolean reset) throws TypedXMLStreamException Method called by the stream reader to decode space-separated tokens that are part of the current text event (contents of which are stored within this buffer), using given decoder.

equalsString	back to summary
public boolean equalsString(String str) Note it is assumed that this method is not used often enough to be a bottleneck, or for long segments. Based on this, it is optimized for common simple cases where there is only one single character segment to use; fallback for other cases is to create such segment.

expand	back to summary
private void expand(int roomNeeded) Method called when current segment is full, to allocate new segment.

finishCurrentSegment	back to summary
public char[] finishCurrentSegment()

fireSaxCharacterEvents	back to summary
public void fireSaxCharacterEvents(ContentHandler h) throws SAXException This is a specialized "accessor" method, which is basically to fire SAX characters() events in an optimal way, based on which internal buffers are being used

fireSaxCommentEvent	back to summary
public void fireSaxCommentEvent(LexicalHandler h) throws SAXException

fireSaxSpaceEvents	back to summary
public void fireSaxSpaceEvents(ContentHandler h) throws SAXException

getBufferWithoutReset	back to summary
public char[] getBufferWithoutReset()

getCurrentLength	back to summary
public int getCurrentLength()

getTextBuffer	back to summary
public char[] getTextBuffer()

isAllWhitespace	back to summary
public boolean isAllWhitespace()

rawContentsTo	back to summary
public int rawContentsTo(Writer w) throws IOException Method that will stream contents of this buffer into specified Writer.

recycle	back to summary
public void recycle(boolean force) 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 calling this method automatically also clears contents of the buffer.

resetForBinaryDecode	back to summary
public void resetForBinaryDecode(Base64Variant v, CharArrayBase64Decoder dec, boolean firstChunk) Method called to initialize given base64 decoder with data contained in this text buffer (for the current event).

resetForDecode	back to summary
private final void resetForDecode()

resetWithChar	back to summary
public void resetWithChar(char c) Method called to initialize the buffer with just a single char

resetWithEmpty	back to summary
public char[] resetWithEmpty() Method called to clear out any content text buffer may have, and initializes and returns the first segment to add characters to.

resetWithIndentation	back to summary
public void resetWithIndentation(int indCharCount, char indChar)

resetWithSurrogate	back to summary
public void resetWithSurrogate(int c)

setCurrentLength	back to summary
public void setCurrentLength(int len)

size	back to summary
public int size() Returns:int Number of characters currently stored by this collector

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Note

calling this method may not be as efficient as calling contentsAsString, since it is guaranteed that resulting String is NOT cached (to ensure we see no stale data)

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

public final Class TextBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail