Tomcat 10.1.19 · org.apache.tomcat.util.buf.CharChunk

Modifier and Type	Class and Description
public static interface	CharChunk.CharInputChannel Input interface, used when the buffer is empty.
public static interface	CharChunk.CharOutputChannel When we need more space we'll either grow the buffer ( up to the limit ) or send it to a channel.

Modifier and Type	Field and Description
private char[]	buff
private transient CharChunk.CharInputChannel	in
private transient CharChunk.CharOutputChannel	out
private static final long	serialVersionUID Hides org.apache.tomcat.util.buf.AbstractChunk.serialVersionUID.

Access	Constructor and Description
public	CharChunk() Creates a new, uninitialized CharChunk object.
public	CharChunk(int initial)

Method Summary

Modifier and Type	Method and Description
public void	allocate(int initial, int limit)
public void	append(char c)
public void	append(CharChunk src)
public void	append(char[] Char array src, int Offset off, int Length len) Add data to the buffer.
public void	append(String The string s) Append a string to the buffer.
public void	append(String The string s, int Offset off, int Length len) Append a string to the buffer.
public char	charAt(int the index of the `char` value to be returned index) Implements java.lang.CharSequence.charAt. Returns the `char` value at the specified index.
private boolean	checkEof()
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	Returns: `true` if the message bytes end with the specified string. endsWith(String The string s)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	Returns: `true` if the comparison succeeded, `false` otherwise equals(String the String to compare s) Compares the message bytes to the specified String object.
public boolean	equals(CharChunk cc)
public boolean	equals(char[] b2, int off2, int len2)
public boolean	Returns: `true` if the comparison succeeded, `false` otherwise equalsIgnoreCase(String the String to compare s) Compares the message bytes to the specified String object.
public void	flushBuffer() Send the buffer to the sink.
public char[]	Returns: the buffer. getBuffer()
protected int	getBufferElement(int index) Implements abstract org.apache.tomcat.util.buf.AbstractChunk.getBufferElement.
public char[]	Returns: the buffer. getChars()
public int	indexOf(char c)
public int	Returns: The position of the first instance of the character or -1 if the character is not found. indexOf(char The character c, int The start position starting) Returns the first instance of the given character in this CharChunk starting at the specified char.
public static int	Returns: The position of the first instance of the character or -1 if the character is not found. indexOf(char[] The array to search chars, int The point to start searching from in the array start, int The point to stop searching in the array end, char The character to search for s) Returns the first instance of the given character in the given char array between the specified start and end.
public int	length() Implements java.lang.CharSequence.length. Returns the length of this character sequence.
public void	makeSpace(int The size count) Make space for len chars.
private int	min(int a, int b)
public void	setCharInputChannel(CharChunk.CharInputChannel The input channel in) When the buffer is empty, read the data from the input channel.
public void	setCharOutputChannel(CharChunk.CharOutputChannel The output channel out) When the buffer is full, write the data to the output channel.
public void	setChars(char[] the characters c, int the start offset of the characters off, int the length of the characters len) Sets the buffer to the specified subarray of characters.
public boolean	Returns: `true` if the message bytes starts with the specified string. startsWith(String The string s)
public boolean	Returns: `true` if the start matches startsWithIgnoreCase(String the string s, int The position pos) Returns true if the buffer starts with the specified string.
public CharSequence	subSequence(int the start index, inclusive start, int the end index, exclusive end) Implements java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public int	subtract()
public int	subtract(char[] dest, int off, int len)
public String	toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence.
public String	toStringInternal()

Inherited from org.apache.tomcat.util.buf.AbstractChunk:: getEnd getLength getLimit getLimitInternal getOffset getStart hash hashCode indexOf isNull recycle setEnd setLimit setOffset

buff	back to summary
private char[] buff

in	back to summary
private transient CharChunk.CharInputChannel in

out	back to summary
private transient CharChunk.CharOutputChannel out

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.tomcat.util.buf.AbstractChunk.serialVersionUID.

CharChunk	back to summary
public CharChunk() Creates a new, uninitialized CharChunk object.

CharChunk	back to summary
public CharChunk(int initial)

Method Detail

allocate	back to summary
public void allocate(int initial, int limit)

append	back to summary
public void append(char c) throws IOException

append	back to summary
public void append(CharChunk src) throws IOException

append	back to summary
public void append(char[] src, int off, int len) throws IOException Add data to the buffer. Parameters src:char[] Char array off:int Offset len:int Length Exceptions IOException: Writing overflow data to the output channel failed

append

back to summary

public void append(char[] src, int off, int len) throws IOException

Add data to the buffer.

Parameters

src:char[]: Char array
off:int: Offset
len:int: Length

Exceptions

IOException:: Writing overflow data to the output channel failed

append	back to summary
public void append(String s) throws IOException Append a string to the buffer. Parameters s:String The string Exceptions IOException: Writing overflow data to the output channel failed

append

back to summary

public void append(String s) throws IOException

Append a string to the buffer.

Parameters

s:String: The string

Exceptions

IOException:: Writing overflow data to the output channel failed

append	back to summary
public void append(String s, int off, int len) throws IOException Append a string to the buffer. Parameters s:String The string off:int Offset len:int Length Exceptions IOException: Writing overflow data to the output channel failed

append

back to summary

public void append(String s, int off, int len) throws IOException

Append a string to the buffer.

Parameters

s:String: The string
off:int: Offset
len:int: Length

Exceptions

IOException:: Writing overflow data to the output channel failed

charAt back to summary

charAt	back to summary
public char charAt(int index) Implements java.lang.CharSequence.charAt. Doc from java.lang.CharSequence.charAt. Returns the `char` value at the specified index. An index ranges from zero to `length() - 1`. The first `char` value of the sequence is at index zero, the next at index one, and so on, as for array indexing. If the `char` value specified by the index is a surrogate, the surrogate value is returned. Parameters index:int the index of the `char` value to be returned Returns:char the specified `char` value Annotations @Override

public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int: the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

checkEof	back to summary
private boolean checkEof() throws IOException

clone back to summary

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

endsWith	back to summary
public boolean endsWith(String s) Parameters s:String The string Returns:boolean `true` if the message bytes end with the specified string.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(String s) Compares the message bytes to the specified String object. Parameters s:String the String to compare Returns:boolean `true` if the comparison succeeded, `false` otherwise

public boolean equals(String s)

Compares the message bytes to the specified String object.

Parameters

s:String: the String to compare

Returns:boolean

true if the comparison succeeded, false otherwise

equals	back to summary
public boolean equals(CharChunk cc)

equals	back to summary
public boolean equals(char[] b2, int off2, int len2)

equalsIgnoreCase back to summary

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(String s) Compares the message bytes to the specified String object. Parameters s:String the String to compare Returns:boolean `true` if the comparison succeeded, `false` otherwise

public boolean equalsIgnoreCase(String s)

Compares the message bytes to the specified String object.

Parameters

s:String: the String to compare

Returns:boolean

true if the comparison succeeded, false otherwise

flushBuffer	back to summary
public void flushBuffer() throws IOException 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. Exceptions IOException: Writing overflow data to the output channel failed

flushBuffer

back to summary

public void flushBuffer() throws IOException

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.

Exceptions

IOException:: Writing overflow data to the output channel failed

getBuffer	back to summary
public char[] getBuffer() Returns:char[] the buffer.

getBufferElement	back to summary
protected int getBufferElement(int index) Implements abstract org.apache.tomcat.util.buf.AbstractChunk.getBufferElement. Annotations @Override

getBufferElement

back to summary

protected int getBufferElement(int index)

Implements abstract org.apache.tomcat.util.buf.AbstractChunk.getBufferElement.

Annotations

@Override

getChars	back to summary
public char[] getChars() Returns:char[] the buffer.

indexOf	back to summary
public int indexOf(char c)

indexOf	back to summary
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:char The character starting:int The start position Returns:int The position of the first instance of the character or -1 if the character is not found.

indexOf

back to summary

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:char: The character
starting:int: The start position

Returns:int

The position of the first instance of the character or -1 if the character is not found.

indexOf	back to summary
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:char[] The array to search start:int The point to start searching from in the array end:int The point to stop searching in the array s:char The character to search for Returns:int The position of the first instance of the character or -1 if the character is not found.

indexOf

back to summary

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:char[]: The array to search
start:int: The point to start searching from in the array
end:int: The point to stop searching in the array
s:char: The character to search for

Returns:int

The position of the first instance of the character or -1 if the character is not found.

length back to summary

length	back to summary
public int length() Implements java.lang.CharSequence.length. Doc from java.lang.CharSequence.length. Returns the length of this character sequence. The length is the number of 16-bit `char`s in the sequence. Returns:int the number of `char`s in this sequence Annotations @Override

public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

makeSpace back to summary

makeSpace	back to summary
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 or `AbstractChunk#ARRAY_MAX_SIZE`. Parameters count:int The size

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 or AbstractChunk#ARRAY_MAX_SIZE.

Parameters

count:int: The size

min	back to summary
private int min(int a, int b)

setCharInputChannel	back to summary
public void setCharInputChannel(CharChunk.CharInputChannel in) When the buffer is empty, read the data from the input channel. Parameters in:CharChunk.CharInputChannel The input channel

setCharInputChannel

back to summary

public void setCharInputChannel(CharChunk.CharInputChannel in)

When the buffer is empty, read the data from the input channel.

Parameters

in:CharChunk.CharInputChannel: The input channel

setCharOutputChannel	back to summary
public void setCharOutputChannel(CharChunk.CharOutputChannel out) 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:CharChunk.CharOutputChannel The output channel

setCharOutputChannel

back to summary

public void setCharOutputChannel(CharChunk.CharOutputChannel out)

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:CharChunk.CharOutputChannel: The output channel

setChars	back to summary
public void setChars(char[] c, int off, int len) Sets the buffer to the specified subarray of characters. Parameters c:char[] the characters off:int the start offset of the characters len:int the length of the characters

setChars

back to summary

public void setChars(char[] c, int off, int len)

Sets the buffer to the specified subarray of characters.

Parameters

c:char[]: the characters
off:int: the start offset of the characters
len:int: the length of the characters

startsWith	back to summary
public boolean startsWith(String s) Parameters s:String The string Returns:boolean `true` if the message bytes starts with the specified string.

startsWithIgnoreCase back to summary

startsWithIgnoreCase	back to summary
public boolean startsWithIgnoreCase(String s, int pos) Returns true if the buffer starts with the specified string. Parameters s:String the string pos:int The position Returns:boolean `true` if the start matches

public boolean startsWithIgnoreCase(String s, int pos)

Returns true if the buffer starts with the specified string.

Parameters

s:String: the string
pos:int: The position

Returns:boolean

true if the start matches

subSequence back to summary

subSequence	back to summary
public CharSequence subSequence(int start, int end) Implements java.lang.CharSequence.subSequence. Doc from java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Parameters start:int the start index, inclusive end:int the end index, exclusive Returns:CharSequence the specified subsequence Annotations @Override

public CharSequence subSequence(int start, int end)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

start:int: the start index, inclusive
end:int: the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

subtract	back to summary
public int subtract() throws IOException

subtract	back to summary
public int subtract(char[] dest, int off, int len) throws IOException

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Doc from java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence. Returns:String a string consisting of exactly this sequence of characters Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Returns:String

a string consisting of exactly this sequence of characters

Annotations

@Override

toStringInternal	back to summary
public String toStringInternal()

public final Class CharChunk

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface CharChunk.CharInputChannel

Method Summary

Method Detail

public Interface CharChunk.CharOutputChannel

Method Summary

Method Detail