Package org.apache.tomcat.util.buf
Class CharChunk
java.lang.Object
org.apache.tomcat.util.buf.AbstractChunk
org.apache.tomcat.util.buf.CharChunk
- All Implemented Interfaces:
- Serializable,- CharSequence,- Cloneable
Utilities to manipulate char chunks. While String is the easiest way to manipulate chars ( search, substrings, etc),
 it is known to not be the most efficient solution - Strings are designed as immutable and secure objects.
- Author:
- dac@sun.com, James Todd [gonzo@sun.com], Costin Manolache, Remy Maucherat
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic interfaceInput interface, used when the buffer is empty.static interfaceWhen we need more space we'll either grow the buffer ( up to the limit ) or send it to a channel.
- 
Field SummaryFields inherited from class org.apache.tomcat.util.buf.AbstractChunkARRAY_MAX_SIZE, end, hasHashCode, isSet, sm, start
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidallocate(int initial, int limit) voidappend(char c) voidappend(char[] src, int off, int len) Add data to the buffer.voidAppend a string to the buffer.voidAppend a string to the buffer.voidcharcharAt(int index) clone()booleanbooleanequals(char[] b2, int off2, int len2) booleanbooleanCompares the message bytes to the specified String object.booleanbooleanCompares the message bytes to the specified String object.voidSend the buffer to the sink.char[]protected intgetBufferElement(int index) char[]getChars()intindexOf(char c) static intindexOf(char[] chars, int start, int end, char s) Returns the first instance of the given character in the given char array between the specified start and end.intindexOf(char c, int starting) Returns the first instance of the given character in this CharChunk starting at the specified char.intlength()voidmakeSpace(int count) Make space for len chars.voidWhen the buffer is empty, read the data from the input channel.voidWhen the buffer is full, write the data to the output channel.voidsetChars(char[] c, int off, int len) Sets the buffer to the specified subarray of characters.booleanstartsWith(String s) booleanstartsWithIgnoreCase(String s, int pos) Returns true if the buffer starts with the specified string.subSequence(int start, int end) intsubtract()intsubtract(char[] dest, int off, int len) toString()Methods inherited from class org.apache.tomcat.util.buf.AbstractChunkgetEnd, getLength, getLimit, getLimitInternal, getOffset, getStart, hash, hashCode, indexOf, isNull, recycle, setEnd, setLimit, setOffsetMethods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.CharSequencechars, codePoints, isEmpty
- 
Constructor Details- 
CharChunkpublic CharChunk()Creates a new, uninitialized CharChunk object.
- 
CharChunkpublic CharChunk(int initial) 
 
- 
- 
Method Details- 
clone- Overrides:
- clonein class- Object
- Throws:
- CloneNotSupportedException
 
- 
allocatepublic void allocate(int initial, int limit) 
- 
setCharspublic void setChars(char[] c, int off, int len) Sets the buffer to the specified subarray of characters.- Parameters:
- c- the characters
- off- the start offset of the characters
- len- the length of the characters
 
- 
getCharspublic char[] getChars()- Returns:
- the buffer.
 
- 
getBufferpublic char[] getBuffer()- Returns:
- the buffer.
 
- 
setCharInputChannelWhen the buffer is empty, read the data from the input channel.- Parameters:
- in- The input channel
 
- 
setCharOutputChannelWhen the buffer is full, write the data to the output channel. Also used when large amount of data is appended. If not set, the buffer will grow to the limit.- Parameters:
- out- The output channel
 
- 
append- Throws:
- IOException
 
- 
append- Throws:
- IOException
 
- 
appendAdd data to the buffer.- Parameters:
- src- Char array
- off- Offset
- len- Length
- Throws:
- IOException- Writing overflow data to the output channel failed
 
- 
appendAppend a string to the buffer.- Parameters:
- s- The string
- Throws:
- IOException- Writing overflow data to the output channel failed
 
- 
appendAppend a string to the buffer.- Parameters:
- s- The string
- off- Offset
- len- Length
- Throws:
- IOException- Writing overflow data to the output channel failed
 
- 
subtract- Throws:
- IOException
 
- 
subtract- Throws:
- IOException
 
- 
flushBufferSend the buffer to the sink. Called by append() when the limit is reached. You can also call it explicitly to force the data to be written.- Throws:
- IOException- Writing overflow data to the output channel failed
 
- 
makeSpacepublic void makeSpace(int count) Make space for len chars. If len is small, allocate a reserve space too. Never grow bigger than the limit orAbstractChunk.ARRAY_MAX_SIZE.- Parameters:
- count- The size
 
- 
toString- Specified by:
- toStringin interface- CharSequence
- Overrides:
- toStringin class- Object
 
- 
toStringInternal
- 
equals
- 
equalsCompares the message bytes to the specified String object.- Parameters:
- s- the String to compare
- Returns:
- trueif the comparison succeeded,- falseotherwise
 
- 
equalsIgnoreCaseCompares the message bytes to the specified String object.- Parameters:
- s- the String to compare
- Returns:
- trueif the comparison succeeded,- falseotherwise
 
- 
equals
- 
equalspublic boolean equals(char[] b2, int off2, int len2) 
- 
startsWith- Parameters:
- s- The string
- Returns:
- trueif the message bytes starts with the specified string.
 
- 
startsWithIgnoreCaseReturns true if the buffer starts with the specified string.- Parameters:
- s- the string
- pos- The position
- Returns:
- trueif the start matches
 
- 
endsWith- Parameters:
- s- The string
- Returns:
- trueif the message bytes end with the specified string.
 
- 
getBufferElementprotected int getBufferElement(int index) - Specified by:
- getBufferElementin class- AbstractChunk
 
- 
indexOfpublic int indexOf(char c) 
- 
indexOfpublic int indexOf(char c, int starting) Returns the first instance of the given character in this CharChunk starting at the specified char. If the character is not found, -1 is returned.- Parameters:
- c- The character
- starting- The start position
- Returns:
- The position of the first instance of the character or -1 if the character is not found.
 
- 
indexOfpublic static int indexOf(char[] chars, int start, int end, char s) Returns the first instance of the given character in the given char array between the specified start and end.- Parameters:
- chars- The array to search
- start- The point to start searching from in the array
- end- The point to stop searching in the array
- s- The character to search for
- Returns:
- The position of the first instance of the character or -1 if the character is not found.
 
- 
charAtpublic char charAt(int index) - Specified by:
- charAtin interface- CharSequence
 
- 
subSequence- Specified by:
- subSequencein interface- CharSequence
 
- 
lengthpublic int length()- Specified by:
- lengthin interface- CharSequence
 
 
-