CharChunk (grizzly-http 2.3.25 API)

java.lang.Object
- org.glassfish.grizzly.http.util.CharChunk

All Implemented Interfaces:

Serializable, Cloneable, Chunk
```
public final class CharChunk
extends Object
implements Chunk, Cloneable, Serializable
```
Utilities to manipluate 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 imutable and secure objects.

Author:

dac@sun.com, James Todd [gonzo@sun.com], Costin Manolache, Remy Maucherat

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CharChunk.CharInputChannel`
`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.

Field Summary

Fields
Modifier and Type Field and Description

static Charset DEFAULT_HTTP_CHARSET
Default encoding used to convert to strings.

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_HTTP_CHARSET` Default encoding used to convert to strings.

Constructor Summary

Constructors
Constructor and Description

CharChunk()
Creates a new, uninitialized CharChunk object.

CharChunk(int size)

Constructors
Constructor and Description
`CharChunk()` Creates a new, uninitialized CharChunk object.
`CharChunk(int size)`

Method Summary

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_HTTP_CHARSET
```
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.
- Constructor Detail
  - CharChunk
```
public CharChunk()
```
    Creates a new, uninitialized CharChunk object.
  - CharChunk
```
public CharChunk(int size)
```
- Method Detail
  - getClone
```
public CharChunk getClone()
```
  - isNull
```
public boolean isNull()
```
  - recycle
```
public void recycle()
```
    Resets the message bytes to an uninitialized state.
  - reset
```
public void reset()
```
  - allocate
```
public void allocate(int initial,
            int limit)
```
  - ensureCapacity
```
public void ensureCapacity(int size)
```
  - setOptimizedWrite
```
public void setOptimizedWrite(boolean optimizedWrite)
```
  - setChars
```
public void setChars(char[] c,
            int off,
            int len)
```
  - setLimit
```
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.
  - getLimit
```
public int getLimit()
```
  - setCharInputChannel
```
public void setCharInputChannel(CharChunk.CharInputChannel in)
```
    When the buffer is empty, read the data from the input channel.
  - setCharOutputChannel
```
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.
  - getChars
```
public char[] getChars()
```
  - getBuffer
```
public char[] getBuffer()
```
  - getStart
```
public int getStart()
```
    Returns the start offset of the bytes. For output this is the end of the buffer.
    
    Specified by:
    
    getStart in interface Chunk
  - setStart
```
public void setStart(int start)
```
    Returns the start offset of the bytes.
    
    Specified by:
    
    setStart in interface Chunk
  - getLength
```
public int getLength()
```
    Returns the length of the bytes.
    
    Specified by:
    
    getLength in interface Chunk
  - getEnd
```
public int getEnd()
```
    Specified by:
    
    getEnd in interface Chunk
  - setEnd
```
public void setEnd(int i)
```
    Specified by:
    
    setEnd in interface Chunk
  - append
```
public void append(char b)
            throws IOException
```
    Throws:
    
    IOException
  - append
```
public void append(CharChunk src)
            throws IOException
```
    Throws:
    
    IOException
  - append
```
public void append(char[] src,
          int off,
          int len)
            throws IOException
```
    Add data to the buffer
    
    Throws:
    
    IOException
  - append
```
public void append(StringBuffer sb)
            throws IOException
```
    Add data to the buffer
    
    Throws:
    
    IOException
  - append
```
public void append(String s)
            throws IOException
```
    Append a string to the buffer
    
    Throws:
    
    IOException
  - append
```
public void append(String s,
          int off,
          int len)
            throws IOException
```
    Append a string to the buffer
    
    Throws:
    
    IOException
  - delete
```
public void delete(int start,
          int end)
```
    Specified by:
    
    delete in interface Chunk
  - substract
```
public int substract()
              throws IOException
```
    Throws:
    
    IOException
  - substract
```
public int substract(CharChunk src)
              throws IOException
```
    Throws:
    
    IOException
  - substract
```
public int substract(char[] src,
            int off,
            int len)
              throws IOException
```
    Throws:
    
    IOException
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Throws:
    
    IOException
  - notifyDirectUpdate
```
protected void notifyDirectUpdate()
```
    Notify the Chunk that its content is going to be changed directly
  - resetStringCache
```
protected final void resetStringCache()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(int start,
              int end)
```
    Specified by:
    
    toString in interface Chunk
  - toStringInternal
```
public String toStringInternal()
```
  - getInt
```
public int getInt()
```
  - set
```
public void set(ByteChunk byteChunk,
       Charset encoding)
         throws CharConversionException
```
    Set ByteChunk content to CharChunk using given Charset.
    
    Throws:
    
    CharConversionException
  - set
```
public void set(BufferChunk bufferChunk,
       Charset encoding)
         throws CharConversionException
```
    Set BufferChunk content to CharChunk using given Charset.
    
    Throws:
    
    CharConversionException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(CharSequence s)
```
    Compares the message bytes to the specified String object.
    
    Parameters:
    s - the String to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
  - equals
```
public boolean equals(byte[] b)
```
    Compares the message bytes to the specified byte array representing ASCII characters.
    
    Parameters:
    b - the byte[] to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
    Since:
    
    2.3
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(CharSequence s)
```
    Compares the message bytes to the specified String object.
    
    Parameters:
    s - the String to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(byte[] b)
```
    Compares the message bytes to the specified byte array representing ASCII characters.
    
    Parameters:
    b - the byte[] to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
    Since:
    
    2.1.2
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(byte[] b,
                       int offset,
                       int len)
```
    Compares the message bytes to the specified byte array representing ASCII characters.
    
    Parameters:
    b - the byte[] to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
    Since:
    
    2.3
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(char[] b,
                       int offset,
                       int len)
```
    Compares the message bytes to the specified char array representing ASCII characters.
    
    Parameters:
    b - the char[] to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
    Since:
    
    2.3
  - equalsIgnoreCaseLowerCase
```
public boolean equalsIgnoreCaseLowerCase(byte[] b)
```
    Compares the char chunk to the specified byte array representing lower-case ASCII characters.
    
    Parameters:
    b - the byte[] to compare
    
    Returns:
    true if the comparison succeeded, false otherwise
    Since:
    
    2.1.2
  - equals
```
public boolean equals(CharChunk cc)
```
  - equals
```
public boolean equals(char[] b2,
             int off2,
             int len2)
```
  - equals
```
public boolean equals(byte[] b2,
             int off2,
             int len2)
```
  - startsWith
```
public boolean startsWith(String s)
```
    Returns true if the message bytes starts with the specified string.
    
    Parameters:
    s - the string
  - startsWithIgnoreCase
```
public boolean startsWithIgnoreCase(String s,
                           int pos)
```
    Returns true if the message bytes starts with the specified string.
    
    Parameters:
    s - the string
  - endsWith
```
public boolean endsWith(String s)
```
  - hash
```
public int hash()
```
  - hashIgnoreCase
```
public int hashIgnoreCase()
```
  - indexOf
```
public int indexOf(char c)
```
  - indexOf
```
public int indexOf(char c,
          int starting)
```
    Returns true if the message bytes starts with the specified string.
    
    Specified by:
    
    indexOf in interface Chunk
    
    Parameters:
    c - the character
  - indexOf
```
public static int indexOf(char[] chars,
          int off,
          int cend,
          char qq)
```
  - indexOf
```
public final int indexOf(String s,
          int fromIndex)
```
    Specified by:
    
    indexOf in interface Chunk
  - indexOf
```
public final int indexOf(String src,
          int srcOff,
          int srcLen,
          int myOff)
```

Class CharChunk

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HTTP_CHARSET

Constructor Detail

CharChunk

CharChunk

Method Detail

getClone

isNull

recycle

reset

allocate

ensureCapacity

setOptimizedWrite

setChars

setLimit

getLimit

setCharInputChannel

setCharOutputChannel

getChars

getBuffer

getStart

setStart

getLength

getEnd

setEnd

append

append

append

append

append

append

delete

substract

substract

substract

flushBuffer

notifyDirectUpdate

resetStringCache

toString

toString

toStringInternal

getInt

set

set

hashCode

equals

equals

equals

equalsIgnoreCase

equalsIgnoreCase

equalsIgnoreCase

equalsIgnoreCase

equalsIgnoreCaseLowerCase

equals

equals

equals

startsWith

startsWithIgnoreCase

endsWith

hash

hashIgnoreCase

indexOf

indexOf

indexOf

indexOf

indexOf