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

Modifier and Type	Class and Description
public static interface	ByteChunk.ByteInputChannel
public static interface	ByteChunk.ByteOutputChannel

Modifier and Type	Field and Description
private byte[]	buff
private String	cachedString
private Charset	cachedStringCharset
private Charset	charset
private static final Charset	DEFAULT_CHARSET Default encoding used to convert to strings.
private int	end
private transient ByteChunk.ByteInputChannel	in
private boolean	isSet
private int	limit
private boolean	optimizedWrite
private transient ByteChunk.ByteOutputChannel	out
private static final long	serialVersionUID
private int	start

Access	Constructor and Description
public	ByteChunk() Creates a new, uninitialized ByteChunk object.
public	ByteChunk(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(byte b)
public void	append(ByteChunk src)
public void	append(byte[] src, int off, int len) Add data to the buffer
pack-priv boolean	canGrow()
public static byte[]	Returns: the byte array value convertToBytes(String to convert to byte array value) Convert specified String to a byte array.
public void	delete(final int start, final int end) Implements org.glassfish.grizzly.http.util.Chunk.delete.
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(final String 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(final byte[] the `byte[]` to compare bytes) Compares the message bytes to the specified byte array.
public boolean	equals(ByteChunk bb)
public boolean	equals(byte[] b2, int off2, int len2)
public boolean	equals(CharChunk cc)
public boolean	equals(char[] c2, int off2, int len2)
public static boolean	equals(final byte[] b1, final int b1Offs, final int b1Len, final byte[] b2, final int b2Offs, final int b2Len)
public static boolean	equals(final byte[] b, int offs, final int len, final String s)
public boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(final String the String to compare s) Compares the message bytes to the specified String object.
public boolean	equalsIgnoreCase(final byte[] b)
public boolean	equalsIgnoreCase(final byte[] b, final int offset, final int len)
public static boolean	equalsIgnoreCase(final byte[] b1, final int b1Offs, final int b1Len, final byte[] b2, final int b2Offs, final int b2Len)
public static boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCase(final byte[] b, final int offset, final int len, final String the String to compare s) Compares the message bytes to the specified String object.
public boolean	equalsIgnoreCaseLowerCase(byte[] cmpTo)
public static boolean	Returns: true if the comparison succeeded, false otherwise equalsIgnoreCaseLowerCase(final byte[] the `byte[]` to compare buffer, final int buffer start start, final int buffer end end, final byte[] byte[] to compare against cmpTo) Compares the buffer chunk to the specified byte array representing lower-case ASCII characters.
public static int	Returns: index of char if found, -1 if not findChar(byte[] buf, int start, int end, char c) Find a character, no side effects.
public static int	Returns: index of char if found, -1 if not findChars(byte[] buf, int start, int end, byte[] c) Find a character, no side effects.
public static int	Returns: index of char if found, -1 if not findNotChars(byte[] buf, int start, int end, byte[] c) Find the first character != c
public void	flushBuffer()
public byte[]	getBuffer() Returns the message bytes.
public byte[]	getBytes() Returns the message bytes.
public Charset	getCharset()
public ByteChunk	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 long	getLong()
public int	getOffset()
public int	getStart() Implements org.glassfish.grizzly.http.util.Chunk.getStart. Returns the start offset of the bytes.
public int	hash()
private static int	hashBytes(byte[] buff, int start, int bytesLen)
private static int	hashBytesIC(byte[] bytes, int start, int bytesLen)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	hashIgnoreCase()
public int	indexOf(final String s, int fromIdx) Implements org.glassfish.grizzly.http.util.Chunk.indexOf.
public int	indexOf(String src, int srcOff, int srcLen, int myOff)
public int	indexOf(char the character c, int The start position starting) Implements org.glassfish.grizzly.http.util.Chunk.indexOf. Returns true if the message bytes starts with the specified string.
public static int	indexOf(byte[] bytes, int off, int end, char qq)
public boolean	isNull()
private void	makeSpace(int count) Make space for len chars.
protected void	notifyDirectUpdate() Notify the Chunk that its content is going to be changed directly
public void	recycle() Resets the message buff to an uninitialized state.
public void	recycleAndReset()
public void	reset()
protected void	resetStringCache()
public void	setByteInputChannel(ByteChunk.ByteInputChannel in) When the buffer is empty, read the data from the input channel.
public void	setByteOutputChannel(ByteChunk.ByteOutputChannel out) When the buffer is full, write the data to the output channel.
public void	setBytes(byte[] the ascii bytes b, int the start offset of the bytes off, int the length of the bytes len) Sets the message bytes to the specified sub-array of bytes.
public void	setCharset(Charset charset)
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	setOffset(int off)
public void	setOptimizedWrite(boolean optimizedWrite)
public void	setStart(int start) Implements org.glassfish.grizzly.http.util.Chunk.setStart.
public boolean	startsWith(String the string s) Returns true if the message bytes starts with the specified string.
public boolean	startsWith(String the string s, int The position offset) Returns true if the message bytes starts with the specified string.
public boolean	startsWith(byte[] b2)
public static boolean	startsWith(final byte[] buffer, final int start, final int end, final byte[] cmpTo)
public boolean	startsWithIgnoreCase(String the string s, int The position pos) Returns true if the message bytes starts with the specified string.
public int	substract()
public int	substract(ByteChunk src)
public int	substract(byte[] 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	toString(Charset charset)
public String	toStringInternal()
public void	trimLeft()

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

buff	back to summary
private byte[] buff

cachedString	back to summary
private String cachedString

cachedStringCharset	back to summary
private Charset cachedStringCharset

charset	back to summary
private Charset charset

DEFAULT_CHARSET	back to summary
private static final Charset DEFAULT_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 ByteChunk.ByteInputChannel 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 ByteChunk.ByteOutputChannel out

serialVersionUID	back to summary
private static final long serialVersionUID

start	back to summary
private int start

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

ByteChunk	back to summary
public ByteChunk(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(byte b) throws IOException

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

append	back to summary
public void append(byte[] src, int off, int len) throws IOException Add data to the buffer

canGrow	back to summary
pack-priv boolean canGrow()

convertToBytes	back to summary
public static byte[] convertToBytes(String value) Convert specified String to a byte array. Parameters value:String to convert to byte array Returns:byte[] the byte array value

convertToBytes

back to summary

public static byte[] convertToBytes(String value)

Convert specified String to a byte array.

Parameters

value:String: to convert to byte array

Returns:byte[]

the byte array value

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

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(final 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(final 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

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

public boolean equals(final byte[] bytes)

Compares the message bytes to the specified byte array.

Parameters

bytes:byte[]: the byte[] to compare

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.3

equals	back to summary
public boolean equals(ByteChunk bb)

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

equals	back to summary
public boolean equals(CharChunk cc)

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

equals	back to summary
public static boolean equals(final byte[] b1, final int b1Offs, final int b1Len, final byte[] b2, final int b2Offs, final int b2Len)

equals	back to summary
public static boolean equals(final byte[] b, int offs, final int len, final String s)

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(final 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

equalsIgnoreCase

back to summary

public boolean equalsIgnoreCase(final 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

equalsIgnoreCase	back to summary
public boolean equalsIgnoreCase(final byte[] b)

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

equalsIgnoreCase	back to summary
public static boolean equalsIgnoreCase(final byte[] b1, final int b1Offs, final int b1Len, final byte[] b2, final int b2Offs, final int b2Len)

equalsIgnoreCase	back to summary
public static boolean equalsIgnoreCase(final byte[] b, final int offset, final int len, final 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

equalsIgnoreCase

back to summary

public static boolean equalsIgnoreCase(final byte[] b, final int offset, final int len, final 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

equalsIgnoreCaseLowerCase	back to summary
public boolean equalsIgnoreCaseLowerCase(byte[] cmpTo)

equalsIgnoreCaseLowerCase back to summary

equalsIgnoreCaseLowerCase	back to summary
public static boolean equalsIgnoreCaseLowerCase(final byte[] buffer, final int start, final int end, final byte[] cmpTo) Compares the buffer chunk to the specified byte array representing lower-case ASCII characters. Parameters buffer:byte[] the `byte[]` to compare start:int buffer start end:int buffer end cmpTo:byte[] byte[] to compare against Returns:boolean true if the comparison succeeded, false otherwise Since 2.3

public static boolean equalsIgnoreCaseLowerCase(final byte[] buffer, final int start, final int end, final byte[] cmpTo)

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

Parameters

buffer:byte[]: the byte[] to compare
start:int: buffer start
end:int: buffer end
cmpTo:byte[]: byte[] to compare against

Returns:boolean

true if the comparison succeeded, false otherwise

Since

2.3

findChar	back to summary
public static int findChar(byte[] buf, int start, int end, char c) Find a character, no side effects. Returns:int index of char if found, -1 if not

findChar

back to summary

public static int findChar(byte[] buf, int start, int end, char c)

Find a character, no side effects.

Returns:int: index of char if found, -1 if not

findChars	back to summary
public static int findChars(byte[] buf, int start, int end, byte[] c) Find a character, no side effects. Returns:int index of char if found, -1 if not

findChars

back to summary

public static int findChars(byte[] buf, int start, int end, byte[] c)

Find a character, no side effects.

Returns:int: index of char if found, -1 if not

findNotChars	back to summary
public static int findNotChars(byte[] buf, int start, int end, byte[] c) Find the first character != c Returns:int index of char if found, -1 if not

findNotChars

back to summary

public static int findNotChars(byte[] buf, int start, int end, byte[] c)

Find the first character != c

Returns:int: index of char if found, -1 if not

flushBuffer	back to summary
public void flushBuffer() throws IOException

getBuffer	back to summary
public byte[] getBuffer() Returns the message bytes.

getBytes	back to summary
public byte[] getBytes() Returns the message bytes.

getCharset	back to summary
public Charset getCharset()

getClone	back to summary
public ByteChunk getClone()

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. XXX need to clean this up

Annotations

@Override

getLimit	back to summary
public int getLimit()

getLong	back to summary
public long getLong()

getOffset	back to summary
public int getOffset()

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()

hashBytes	back to summary
private static int hashBytes(byte[] buff, int start, int bytesLen)

hashBytesIC	back to summary
private static int hashBytesIC(byte[] bytes, int start, int bytesLen)

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

hashIgnoreCase	back to summary
public int hashIgnoreCase()

indexOf

back to summary

public int indexOf(final String s, int fromIdx)

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)

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

Annotations

@Override

indexOf	back to summary
public static int indexOf(byte[] bytes, int off, int end, char qq)

isNull	back to summary
public boolean isNull()

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

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 buff to an uninitialized state.

recycleAndReset	back to summary
public void recycleAndReset()

reset	back to summary
public void reset()

resetStringCache	back to summary
protected void resetStringCache()

setByteInputChannel	back to summary
public void setByteInputChannel(ByteChunk.ByteInputChannel in) When the buffer is empty, read the data from the input channel.

setByteOutputChannel	back to summary
public void setByteOutputChannel(ByteChunk.ByteOutputChannel 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.

setBytes

back to summary

public void setBytes(byte[] b, int off, int len)

Sets the message bytes to the specified sub-array of bytes.

Parameters

b:byte[]: the ascii bytes
off:int: the start offset of the bytes
len:int: the length of the bytes

setCharset	back to summary
public void setCharset(Charset charset)

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.

setOffset	back to summary
public void setOffset(int off)

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.

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

public boolean startsWith(String s, int offset)

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

Parameters

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

startsWith	back to summary
public boolean startsWith(byte[] b2)

startsWith	back to summary
public static boolean startsWith(final byte[] buffer, final int start, final int end, final byte[] cmpTo)

startsWithIgnoreCase

back to summary

public boolean startsWithIgnoreCase(String s, int pos)

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

Parameters

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

substract	back to summary
public int substract() throws IOException

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

substract	back to summary
public int substract(byte[] 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

toString	back to summary
public String toString(Charset charset)

toStringInternal	back to summary
public String toStringInternal()

trimLeft	back to summary
public void trimLeft()

public final Class ByteChunk

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ByteChunk.ByteInputChannel

Method Summary

Method Detail

public Interface ByteChunk.ByteOutputChannel

Method Summary

Method Detail