CharChunk (Struts 2 Core 2.6-SNAPSHOT API)

java.lang.Object
- org.apache.struts2.util.tomcat.buf.CharChunk

All Implemented Interfaces:

Serializable, CharSequence, Cloneable
```
public final class CharChunk
extends Object
implements Cloneable, Serializable, CharSequence
```
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:

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.

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

All Methods Static Methods Instance Methods Concrete 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(String s, int off, int len)` Append a string to the buffer
`char`	`charAt(int index)`
`boolean`	`endsWith(String s)` Returns true if the message bytes end with the specified string.
`boolean`	`equals(char[] b2, int off2, int len2)`
`boolean`	`equals(CharChunk cc)`
`boolean`	`equals(Object obj)`
`boolean`	`equals(String s)` Compares the message bytes to the specified String object.
`boolean`	`equalsIgnoreCase(String s)` Compares the message bytes to the specified String object.
`void`	`flushBuffer()`
`char[]`	`getBuffer()`
`char[]`	`getChars()`
`int`	`getEnd()`
`int`	`getLength()` Returns the length of the bytes.
`int`	`getLimit()`
`int`	`getOffset()`
`int`	`getStart()` Returns the start offset of the bytes.
`int`	`hash()`
`int`	`hashCode()`
`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 src, int srcOff, int srcLen, int myOff)`
`boolean`	`isNull()`
`int`	`length()`
`void`	`makeSpace(int count)` Make space for len chars.
`void`	`recycle()` Resets the message bytes to an uninitialized state.
`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`	`setOffset(int off)` Returns the start offset of the bytes.
`void`	`setOptimizedWrite(boolean optimizedWrite)`
`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.
`CharSequence`	`subSequence(int start, int end)`
`int`	`substract()`
`int`	`substract(char[] src, int off, int len)`
`String`	`toString()`
`String`	`toStringInternal()`

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

Methods inherited from interface java.lang.CharSequence
chars, codePoints

Constructor Detail
- CharChunk
```
public CharChunk()
```
  Creates a new, uninitialized CharChunk object.
- CharChunk
```
public CharChunk(int size)
```

Method Detail

isNull
```
public boolean isNull()
```

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

allocate

public void allocate(int initial,
                     int limit)

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.

getOffset
```
public int getOffset()
```

setOffset
```
public void setOffset(int off)
```
Returns the start offset of the bytes.

getLength
```
public int getLength()
```
Returns the length of the bytes.

getEnd
```
public int getEnd()
```

setEnd
```
public void setEnd(int i)
```

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

substract

public int substract()
              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

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

toString
```
public String toString()
```
Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

toStringInternal
```
public String toStringInternal()
```

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

equals
```
public boolean equals(String 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(String 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(CharChunk cc)
```

equals

public boolean equals(char[] 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)
```
Returns true if the message bytes end with the specified string.

Parameters:

s - the string

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

hash
```
public int hash()
```

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.

Parameters:

c - the character

indexOf

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

indexOf

public int indexOf(String src,
                   int srcOff,
                   int srcLen,
                   int myOff)

charAt
```
public char charAt(int index)
```
Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:: subSequence in interface CharSequence

length
```
public int length()
```
Specified by:

length in interface CharSequence

Class CharChunk

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Constructor Detail

CharChunk

CharChunk

Method Detail

isNull

recycle

allocate

setOptimizedWrite

setChars

setLimit

getLimit

setCharInputChannel

setCharOutputChannel

getChars

getBuffer

getStart

getOffset

setOffset

getLength

getEnd

setEnd

append

append

append

append

append

substract

substract

flushBuffer

makeSpace

toString

toStringInternal

equals

equals

equalsIgnoreCase

equals

equals

startsWith

startsWithIgnoreCase

endsWith

hashCode

hash

indexOf

indexOf

indexOf

indexOf

charAt

subSequence

length