Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.util.CharChunk

Modifier and Type	Class and Description
public static interface	CharChunk.CharInputChannel
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 String	cachedString
public static final Charset	DEFAULT_HTTP_CHARSET Default encoding used to convert to strings.
private int	end
private transient CharChunk.CharInputChannel	in
private boolean	isSet
private int	limit
private boolean	optimizedWrite
private transient CharChunk.CharOutputChannel	out
private static final long	serialVersionUID
private int	start

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

Method Summary

Modifier and Type	Method and Description
public void	allocate(int initial, int limit)
public void	append(char b)
public void	append(CharChunk src)
public void	append(char[] src, int off, int len) Add data to the buffer
public void	append(StringBuffer sb) Add data to the buffer
public void	append(String s) Append a string to the buffer
public void	append(String s, int off, int len) Append a string to the buffer
public void	delete(final int start, final int end) Implements org.glassfish.grizzly.http.util.Chunk.delete.
public boolean	endsWith(String s)
public void	ensureCapacity(final int size)
public boolean	equals(Object o) 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(CharSequence the String to compare s) Compares the message bytes to the specified String object.
public boolean	Returns: true if the comparison succeeded, false otherwise equals(byte[] the `byte[]` to compare b) Compares the message bytes to the specified byte array representing ASCII characters.
public boolean	equals(CharChunk cc)
public boolean	equals(char[] b2, int off2, int len2)
public boolean	equals(byte[] b2, int off2, int len2)
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(CharSequence the String to compare s) Compares the message bytes to the specified String object.
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(final byte[] the `byte[]` to compare b) Compares the message bytes to the specified byte array representing ASCII characters.
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(final byte[] the `byte[]` to compare b, final int offset, final int len) Compares the message bytes to the specified byte array representing ASCII characters.
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(final char[] the `char[]` to compare b, final int offset, final int len) Compares the message bytes to the specified char array representing ASCII characters.
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCaseLowerCase(final byte[] the `byte[]` to compare b) Compares the char chunk to the specified byte array representing lower-case ASCII characters.
public void	flushBuffer()
public char[]	getBuffer()
public char[]	getChars()
public CharChunk	getClone()
public int	getEnd() Implements org.glassfish.grizzly.http.util.Chunk.getEnd.
public int	getInt()
public int	getLength() Implements org.glassfish.grizzly.http.util.Chunk.getLength. Returns the length of the bytes.
public int	getLimit()
public int	getStart() Implements org.glassfish.grizzly.http.util.Chunk.getStart. Returns the start offset of the bytes.
public int	hash()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	hashIgnoreCase()
public int	indexOf(char c)
public int	indexOf(char the character c, int starting) Implements org.glassfish.grizzly.http.util.Chunk.indexOf. Returns true if the message bytes starts with the specified string.
public static int	indexOf(char[] chars, int off, int cend, char qq)
public int	indexOf(String s, int fromIndex) Implements org.glassfish.grizzly.http.util.Chunk.indexOf.
public int	indexOf(String src, int srcOff, int srcLen, int myOff)
public boolean	isNull()
pack-priv void	makeSpace(int count) Make space for len chars.
private int	min(int a, int b)
protected void	notifyDirectUpdate() Notify the Chunk that its content is going to be changed directly
public void	recycle() Resets the message bytes to an uninitialized state.
public void	reset()
protected void	resetStringCache()
public void	set(final ByteChunk byteChunk, final Charset encoding) Set `ByteChunk` content to CharChunk using given `Charset`.
public void	set(final BufferChunk bufferChunk, final Charset encoding) Set `BufferChunk` content to CharChunk using given `Charset`.
public void	setCharInputChannel(CharChunk.CharInputChannel in) When the buffer is empty, read the data from the input channel.
public void	setCharOutputChannel(CharChunk.CharOutputChannel out) When the buffer is full, write the data to the output channel.
public void	setChars(char[] c, int off, int len)
public void	setEnd(int i) Implements org.glassfish.grizzly.http.util.Chunk.setEnd.
public void	setLimit(int limit) Maximum amount of data in this buffer.
public void	setOptimizedWrite(boolean optimizedWrite)
public void	setStart(int start) Implements org.glassfish.grizzly.http.util.Chunk.setStart. Returns the start offset of the bytes.
public boolean	startsWith(String the string s) Returns true if the message bytes starts with the specified string.
pack-priv boolean	startsWith(final String s, final int pos)
public boolean	startsWithIgnoreCase(final String the string s, final int pos) Returns true if the message bytes starts with the specified string.
public int	substract()
public int	substract(CharChunk src)
public int	substract(char[] src, int off, int len)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(int start, int end) Implements org.glassfish.grizzly.http.util.Chunk.toString.
public String	toStringInternal()
public void	trimLeft()

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

buff	back to summary
private char[] buff

cachedString	back to summary
private String cachedString

DEFAULT_HTTP_CHARSET	back to summary
public static final Charset DEFAULT_HTTP_CHARSET Default encoding used to convert to strings. It should be UTF8, as most standards seem to converge, but the servlet API requires 8859_1, and this object is used mostly for servlets.

end	back to summary
private int end

in	back to summary
private transient CharChunk.CharInputChannel in

isSet	back to summary
private boolean isSet

limit	back to summary
private int limit

optimizedWrite	back to summary
private boolean optimizedWrite

out	back to summary
private transient CharChunk.CharOutputChannel out

serialVersionUID	back to summary
private static final long serialVersionUID

start	back to summary
private int start

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

CharChunk	back to summary
public CharChunk(int size)

Method Detail

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

append	back to summary
public void append(char b) 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

append	back to summary
public void append(StringBuffer sb) throws IOException Add data to the buffer

append	back to summary
public void append(String s) throws IOException Append a string to the buffer

append	back to summary
public void append(String s, int off, int len) throws IOException Append a string to the buffer

delete	back to summary
public void delete(final int start, final int end) Implements org.glassfish.grizzly.http.util.Chunk.delete. Annotations @Override

delete

back to summary

public void delete(final int start, final int end)

Implements org.glassfish.grizzly.http.util.Chunk.delete.

Annotations

@Override

endsWith	back to summary
public boolean endsWith(String s)

ensureCapacity	back to summary
public void ensureCapacity(final int size)

equals back to summary

equals	back to summary
public boolean equals(Object o) 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. Annotations @Override

public boolean equals(Object o)

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.

Annotations

@Override

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

equals

back to summary

public boolean equals(CharSequence s)

Compares the message bytes to the specified String object.

Parameters

s:CharSequence: the String to compare

Returns:boolean

true if the comparison succeeded, false otherwise

equals back to summary

equals	back to summary
public boolean equals(byte[] b) Compares the message bytes to the specified byte array representing ASCII characters. Parameters b:byte[] the `byte[]` to compare Returns:boolean true if the comparison succeeded, false otherwise Since 2.3

public boolean equals(byte[] b)

Compares the message bytes to the specified byte array representing ASCII characters.

Parameters

b:byte[]: the byte[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.3

equals	back to summary
public boolean equals(CharChunk cc)

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

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

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

equalsIgnoreCase

back to summary

public boolean equalsIgnoreCase(CharSequence s)

Compares the message bytes to the specified String object.

Parameters

s:CharSequence: the String to compare

Returns:boolean

true if the comparison succeeded, false otherwise

equalsIgnoreCase back to summary

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(final byte[] b) Compares the message bytes to the specified byte array representing ASCII characters. Parameters b:byte[] the `byte[]` to compare Returns:boolean true if the comparison succeeded, false otherwise Since 2.1.2

public boolean equalsIgnoreCase(final byte[] b)

Compares the message bytes to the specified byte array representing ASCII characters.

Parameters

b:byte[]: the byte[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.1.2

equalsIgnoreCase back to summary

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(final byte[] b, final int offset, final int len) Compares the message bytes to the specified byte array representing ASCII characters. Parameters b:byte[] the `byte[]` to compare Returns:boolean true if the comparison succeeded, false otherwise Since 2.3

public boolean equalsIgnoreCase(final byte[] b, final int offset, final int len)

Compares the message bytes to the specified byte array representing ASCII characters.

Parameters

b:byte[]: the byte[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.3

equalsIgnoreCase back to summary

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(final char[] b, final int offset, final int len) Compares the message bytes to the specified char array representing ASCII characters. Parameters b:char[] the `char[]` to compare Returns:boolean true if the comparison succeeded, false otherwise Since 2.3

public boolean equalsIgnoreCase(final char[] b, final int offset, final int len)

Compares the message bytes to the specified char array representing ASCII characters.

Parameters

b:char[]: the char[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.3

equalsIgnoreCaseLowerCase back to summary

equalsIgnoreCaseLowerCase	back to summary
public boolean equalsIgnoreCaseLowerCase(final byte[] b) Compares the char chunk to the specified byte array representing lower-case ASCII characters. Parameters b:byte[] the `byte[]` to compare Returns:boolean true if the comparison succeeded, false otherwise Since 2.1.2

public boolean equalsIgnoreCaseLowerCase(final byte[] b)

Compares the char chunk to the specified byte array representing lower-case ASCII characters.

Parameters

b:byte[]: the byte[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.1.2

flushBuffer	back to summary
public void flushBuffer() throws IOException

getBuffer	back to summary
public char[] getBuffer()

getChars	back to summary
public char[] getChars()

getClone	back to summary
public CharChunk getClone()

getEnd	back to summary
public int getEnd() Implements org.glassfish.grizzly.http.util.Chunk.getEnd. Annotations @Override

getEnd

back to summary

public int getEnd()

Implements org.glassfish.grizzly.http.util.Chunk.getEnd.

Annotations

@Override

getInt	back to summary
public int getInt()

getLength	back to summary
public int getLength() Implements org.glassfish.grizzly.http.util.Chunk.getLength. Returns the length of the bytes. Annotations @Override

getLength

back to summary

public int getLength()

Implements org.glassfish.grizzly.http.util.Chunk.getLength.

Returns the length of the bytes.

Annotations

@Override

getLimit	back to summary
public int getLimit()

getStart	back to summary
public int getStart() Implements org.glassfish.grizzly.http.util.Chunk.getStart. Returns the start offset of the bytes. For output this is the end of the buffer. Annotations @Override

getStart

back to summary

public int getStart()

Implements org.glassfish.grizzly.http.util.Chunk.getStart.

Returns the start offset of the bytes. For output this is the end of the buffer.

Annotations

@Override

hash	back to summary
public int hash()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

hashIgnoreCase	back to summary
public int hashIgnoreCase()

indexOf	back to summary
public int indexOf(char c)

indexOf

back to summary

public int indexOf(char c, int starting)

Implements org.glassfish.grizzly.http.util.Chunk.indexOf.

Returns true if the message bytes starts with the specified string.

Parameters

c:char: the character

Annotations

@Override

indexOf	back to summary
public static int indexOf(char[] chars, int off, int cend, char qq)

indexOf

back to summary

public int indexOf(String s, int fromIndex)

Implements org.glassfish.grizzly.http.util.Chunk.indexOf.

Annotations

@Override

indexOf	back to summary
public int indexOf(String src, int srcOff, int srcLen, int myOff)

isNull	back to summary
public boolean isNull()

makeSpace	back to summary
pack-priv void makeSpace(int count) Make space for len chars. If len is small, allocate a reserve space too. Never grow bigger than limit.

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

notifyDirectUpdate	back to summary
protected void notifyDirectUpdate() Notify the Chunk that its content is going to be changed directly

recycle	back to summary
public void recycle() Resets the message bytes to an uninitialized state.

reset	back to summary
public void reset()

resetStringCache	back to summary
protected void resetStringCache()

set	back to summary
public void set(final ByteChunk byteChunk, final Charset encoding) throws CharConversionException Set `ByteChunk` content to CharChunk using given `Charset`.

set	back to summary
public void set(final BufferChunk bufferChunk, final Charset encoding) throws CharConversionException Set `BufferChunk` content to CharChunk using given `Charset`.

setCharInputChannel	back to summary
public void setCharInputChannel(CharChunk.CharInputChannel in) When the buffer is empty, read the data from 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.

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

setEnd

back to summary

public void setEnd(int i)

Implements org.glassfish.grizzly.http.util.Chunk.setEnd.

Annotations

@Override

setLimit	back to summary
public void setLimit(int limit) Maximum amount of data in this buffer. If -1 or not set, the buffer will grow indefinitely. Can be smaller than the current buffer size ( which will not shrink ). When the limit is reached, the buffer will be flushed ( if out is set ) or throw exception.

setOptimizedWrite	back to summary
public void setOptimizedWrite(boolean optimizedWrite)

setStart

back to summary

public void setStart(int start)

Implements org.glassfish.grizzly.http.util.Chunk.setStart.

Returns the start offset of the bytes.

Annotations

@Override

startsWith

back to summary

public boolean startsWith(String s)

Returns true if the message bytes starts with the specified string.

Parameters

s:String: the string

startsWith	back to summary
pack-priv boolean startsWith(final String s, final int pos)

startsWithIgnoreCase

back to summary

public boolean startsWithIgnoreCase(final String s, final int pos)

Returns true if the message bytes starts with the specified string.

Parameters

s:String: the string

substract	back to summary
public int substract() throws IOException

substract	back to summary
public int substract(CharChunk src) throws IOException

substract	back to summary
public int substract(char[] src, int off, int len) throws IOException

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

toString

back to summary

public String toString(int start, int end)

Implements org.glassfish.grizzly.http.util.Chunk.toString.

Annotations

@Override

toStringInternal	back to summary
public String toStringInternal()

trimLeft	back to summary
public void trimLeft()

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