public final class

CharArrayBuffer

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.http.util.CharArrayBuffer

Class Overview

A resizable char array.

Summary

Public Constructors
CharArrayBuffer(int capacity)
Creates an instance of CharArrayBuffer with the given initial capacity.
Public Methods
void append(char[] b, int off, int len)
Appends len chars to this buffer from the given source array starting at index off.
void append(String str)
Appends chars of the given string to this buffer.
void append(byte[] b, int off, int len)
Appends len bytes to this buffer from the given source array starting at index off.
void append(char ch)
Appends ch char to this buffer.
void append(Object obj)
Appends chars of the textual representation of the given object to this buffer.
void append(CharArrayBuffer b, int off, int len)
Appends len chars to this buffer from the given source buffer starting at index off.
void append(CharArrayBuffer b)
Appends all chars to this buffer from the given source buffer starting at index 0.
void append(ByteArrayBuffer b, int off, int len)
Appends len bytes to this buffer from the given source array starting at index off.
char[] buffer()
Returns reference to the underlying char array.
int capacity()
Returns the current capacity.
char charAt(int i)
Returns the char value in this buffer at the specified index.
void clear()
Clears content of the buffer.
void ensureCapacity(int required)
Ensures that the capacity is at least equal to the specified minimum.
int indexOf(int ch, int beginIndex, int endIndex)
Returns the index within this buffer of the first occurrence of the specified character, starting the search at the specified beginIndex and finishing at endIndex.
int indexOf(int ch)
Returns the index within this buffer of the first occurrence of the specified character, starting the search at 0 and finishing at length().
boolean isEmpty()
Returns true if this buffer is empty, that is, its length() is equal to 0.
boolean isFull()
Returns true if this buffer is full, that is, its length() is equal to its capacity().
int length()
Returns the length of the buffer (char count).
void setLength(int len)
Sets the length of the buffer.
String substring(int beginIndex, int endIndex)
Returns a substring of this buffer.
String substringTrimmed(int beginIndex, int endIndex)
Returns a substring of this buffer with leading and trailing whitespace omitted.
char[] toCharArray()
Converts the content of this buffer to an array of chars.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CharArrayBuffer (int capacity)

Creates an instance of CharArrayBuffer with the given initial capacity.

Parameters
capacity the capacity

Public Methods

public void append (char[] b, int off, int len)

Appends len chars to this buffer from the given source array starting at index off. The capacity of the buffer is increased, if necessary, to accommodate all len chars.

Parameters
b the chars to be appended.
off the index of the first char to append.
len the number of chars to append.
Throws
IndexOutOfBoundsException if off is out of range, len is negative, or off + len is out of range.

public void append (String str)

Appends chars of the given string to this buffer. The capacity of the buffer is increased, if necessary, to accommodate all chars.

Parameters
str the string.

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

Appends len bytes to this buffer from the given source array starting at index off. The capacity of the buffer is increased, if necessary, to accommodate all len bytes.

The bytes are converted to chars using simple cast.

Parameters
b the bytes to be appended.
off the index of the first byte to append.
len the number of bytes to append.
Throws
IndexOutOfBoundsException if off is out of range, len is negative, or off + len is out of range.

public void append (char ch)

Appends ch char to this buffer. The capacity of the buffer is increased, if necessary, to accommodate the additional char.

Parameters
ch the char to be appended.

public void append (Object obj)

Appends chars of the textual representation of the given object to this buffer. The capacity of the buffer is increased, if necessary, to accommodate all chars.

Parameters
obj the object.

public void append (CharArrayBuffer b, int off, int len)

Appends len chars to this buffer from the given source buffer starting at index off. The capacity of the destination buffer is increased, if necessary, to accommodate all len chars.

Parameters
b the source buffer to be appended.
off the index of the first char to append.
len the number of chars to append.
Throws
IndexOutOfBoundsException if off is out of range, len is negative, or off + len is out of range.

public void append (CharArrayBuffer b)

Appends all chars to this buffer from the given source buffer starting at index 0. The capacity of the destination buffer is increased, if necessary, to accommodate all length() chars.

Parameters
b the source buffer to be appended.

public void append (ByteArrayBuffer b, int off, int len)

Appends len bytes to this buffer from the given source array starting at index off. The capacity of the buffer is increased, if necessary, to accommodate all len bytes.

The bytes are converted to chars using simple cast.

Parameters
b the bytes to be appended.
off the index of the first byte to append.
len the number of bytes to append.
Throws
IndexOutOfBoundsException if off is out of range, len is negative, or off + len is out of range.

public char[] buffer ()

Returns reference to the underlying char array.

Returns
  • the char array.

public int capacity ()

Returns the current capacity. The capacity is the amount of storage available for newly appended chars, beyond which an allocation will occur.

Returns
  • the current capacity

public char charAt (int i)

Returns the char value in this buffer at the specified index. The index argument must be greater than or equal to 0, and less than the length of this buffer.

Parameters
i the index of the desired char value.
Returns
  • the char value at the specified index.
Throws
IndexOutOfBoundsException if index is negative or greater than or equal to length().

public void clear ()

Clears content of the buffer. The underlying char array is not resized.

public void ensureCapacity (int required)

Ensures that the capacity is at least equal to the specified minimum. If the current capacity is less than the argument, then a new internal array is allocated with greater capacity. If the required argument is non-positive, this method takes no action.

Parameters
required the minimum required capacity.

public int indexOf (int ch, int beginIndex, int endIndex)

Returns the index within this buffer of the first occurrence of the specified character, starting the search at the specified beginIndex and finishing at endIndex. If no such character occurs in this buffer within the specified bounds, -1 is returned.

There is no restriction on the value of beginIndex and endIndex. If beginIndex is negative, it has the same effect as if it were zero. If endIndex is greater than length(), it has the same effect as if it were length(). If the beginIndex is greater than the endIndex, -1 is returned.

Parameters
ch the char to search for.
beginIndex the index to start the search from.
endIndex the index to finish the search at.
Returns
  • the index of the first occurrence of the character in the buffer within the given bounds, or -1 if the character does not occur.

public int indexOf (int ch)

Returns the index within this buffer of the first occurrence of the specified character, starting the search at 0 and finishing at length(). If no such character occurs in this buffer within those bounds, -1 is returned.

Parameters
ch the char to search for.
Returns
  • the index of the first occurrence of the character in the buffer, or -1 if the character does not occur.

public boolean isEmpty ()

Returns true if this buffer is empty, that is, its length() is equal to 0.

Returns
  • true if this buffer is empty, false otherwise.

public boolean isFull ()

Returns true if this buffer is full, that is, its length() is equal to its capacity().

Returns
  • true if this buffer is full, false otherwise.

public int length ()

Returns the length of the buffer (char count).

Returns
  • the length of the buffer

public void setLength (int len)

Sets the length of the buffer. The new length value is expected to be less than the current capacity and greater than or equal to 0.

Parameters
len the new length
Throws
IndexOutOfBoundsException if the len argument is greater than the current capacity of the buffer or less than 0.

public String substring (int beginIndex, int endIndex)

Returns a substring of this buffer. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1.

Parameters
beginIndex the beginning index, inclusive.
endIndex the ending index, exclusive.
Returns
  • the specified substring.
Throws
StringIndexOutOfBoundsException if the beginIndex is negative, or endIndex is larger than the length of this buffer, or beginIndex is larger than endIndex.

public String substringTrimmed (int beginIndex, int endIndex)

Returns a substring of this buffer with leading and trailing whitespace omitted. The substring begins with the first non-whitespace character from beginIndex and extends to the last non-whitespace character with the index lesser than endIndex.

Parameters
beginIndex the beginning index, inclusive.
endIndex the ending index, exclusive.
Returns
  • the specified substring.
Throws
IndexOutOfBoundsException if the beginIndex is negative, or endIndex is larger than the length of this buffer, or beginIndex is larger than endIndex.

public char[] toCharArray ()

Converts the content of this buffer to an array of chars.

Returns
  • char array

public String toString ()