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 Summary
Nested 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 Summary
Fields inherited from class org.apache.tomcat.util.buf.AbstractChunk
ARRAY_MAX_SIZE, end, hasHashCode, isSet, sm, start -
Constructor Summary
Constructors -
Method Summary
Modifier 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.AbstractChunk
getEnd, getLength, getLimit, getLimitInternal, getOffset, getStart, hash, hashCode, indexOf, isNull, recycle, setEnd, setLimit, setOffset, setStartMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.CharSequence
chars, codePoints, isEmpty
-
Constructor Details
-
CharChunk
public CharChunk()Creates a new, uninitialized CharChunk object. -
CharChunk
public CharChunk(int initial)
-
-
Method Details
-
clone
- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
allocate
public void allocate(int initial, int limit) -
setChars
public void setChars(char[] c, int off, int len) Sets the buffer to the specified subarray of characters.- Parameters:
c- the charactersoff- the start offset of the characterslen- the length of the characters
-
getChars
public char[] getChars()- Returns:
- the buffer.
-
getBuffer
public char[] getBuffer()- Returns:
- the buffer.
-
setCharInputChannel
When the buffer is empty, read the data from the input channel.- Parameters:
in- The input channel
-
setCharOutputChannel
When 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
-
append
Add data to the buffer.- Parameters:
src- Char arrayoff- Offsetlen- Length- Throws:
IOException- Writing overflow data to the output channel failed
-
append
Append a string to the buffer.- Parameters:
s- The string- Throws:
IOException- Writing overflow data to the output channel failed
-
append
Append a string to the buffer.- Parameters:
s- The stringoff- Offsetlen- Length- Throws:
IOException- Writing overflow data to the output channel failed
-
subtract
- Throws:
IOException
-
subtract
- Throws:
IOException
-
flushBuffer
Send 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
-
makeSpace
public 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 interfaceCharSequence- Overrides:
toStringin classObject
-
toStringInternal
-
equals
-
equals
Compares the message bytes to the specified String object.- Parameters:
s- the String to compare- Returns:
trueif the comparison succeeded,falseotherwise
-
equalsIgnoreCase
Compares the message bytes to the specified String object.- Parameters:
s- the String to compare- Returns:
trueif the comparison succeeded,falseotherwise
-
equals
-
equals
public boolean equals(char[] b2, int off2, int len2) -
startsWith
- Parameters:
s- The string- Returns:
trueif the message bytes starts with the specified string.
-
startsWithIgnoreCase
Returns true if the buffer starts with the specified string.- Parameters:
s- the stringpos- The position- Returns:
trueif the start matches
-
endsWith
- Parameters:
s- The string- Returns:
trueif the message bytes end with the specified string.
-
getBufferElement
protected int getBufferElement(int index) - Specified by:
getBufferElementin classAbstractChunk- Parameters:
index- the element location in the buffer- Returns:
- the element
-
indexOf
public int indexOf(char c) -
indexOf
public 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 characterstarting- The start position- Returns:
- The position of the first instance of the character or -1 if the character is not found.
-
indexOf
public 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 searchstart- The point to start searching from in the arrayend- The point to stop searching in the arrays- The character to search for- Returns:
- The position of the first instance of the character or -1 if the character is not found.
-
charAt
public char charAt(int index) - Specified by:
charAtin interfaceCharSequence
-
subSequence
- Specified by:
subSequencein interfaceCharSequence
-
length
public int length()- Specified by:
lengthin interfaceCharSequence
-