Class StringBuffer

---

Object
   |
   --StringBuffer

This is an attempt at an exact clone of the StringBuffer class for Java
 It contains all of the same methods, and emulates the same methods and steps that are taken in Java.

 You have more control than simply using PHP's .= append feature, because you can work with only
 one string at a time, making adjustments to that buffer as you work, and call common requests on
 that buffer.

• Package: lang
• Version: 2003/04/16 11:03 PM
• Since: Japha 1.0 @
• Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

• void append()
  
• char charAt()
  
• void deleteCharAt()
  
• char[] getChars()
  
• int indexOf()
  
• void insert()
  
• int length()
  
• void reverse()
  
• void setCharAt()
  
• void setLength()
  
• char[] subSequence()
  
• String substring()
  
• String toString()
  
• void __construct()
  

Inherited Method Summary

Inherited From Class Object

• clone()
  
• equals()
  
• equalsIgnoreCase()
  
• finalize()
  
• getClass()
  
• toString()
  
• wait()
  

Variable Detail

Method Detail

• void append()
  
  Usage: append ( $char )
  
  

  Add a value to the end of the buffer.

  Parameters

  • char $char - The char (or String) to append. @

  Info

  • Throws: Exception
  • Access: public
  
  
• char charAt()
  
  Usage: charAt ( $index )
  
  

  Returns the character at a specific offset in a buffer.

  Parameters

  • index $index - The offset to return. @

  Info

  • Return: The character at the specific offset @
  • Access: public
  
  
• void deleteCharAt()
  
  Usage: deleteCharAt ( $index )
  
  

  Removes a character from the buffer at a specific offset

  Parameters

  • index $index - The offset to remove. @

  Info

  • Access: public
  
  
• char[] getChars()
  
  Usage: getChars ( $start, $end, $array, [$arrayIndex = 0] )
  
  

  Fill up a passed array with values from the buffer, beginning and ending at specific offsets

  Parameters

  • start $start - The starting offset. @
  • end $end - The ending offset. @
  • array $array - The array to populate (passed by reference). @
  • arrayIndex $arrayIndex - The offset to start at in the passed array. @

  Info

  • Return: the modified array of chars
  • Access: public
  
  
• int indexOf()
  
  Usage: indexOf ( $char )
  
  

  Returns the first occurence of a value in the buffer.

  Parameters

  • char $char - The character to search for. @

  Info

  • Return: the index of the element, if found @
  • Access: public
  
  
• void insert()
  
  Usage: insert ( $offset, $data )
  
  

  Insert data into an already populated StringBuffer. Insert at a specific offset, and pushes
   existing text backwards.

  Parameters

  • offset $offset - The offset to start at in the buffer. @
  • data $data - The char (or String) to insert into the buffer. @

  Info

  • Throws: Exception
  • Access: public
  
  
• int length()
  
  Usage: length ( )
  
  

  Returns the length of the current buffer.

  Parameters

  Info

  • Return: number of indices in the buffer
  • Access: public
  
  
• void reverse()
  
  Usage: reverse ( )
  
  

  Flips the current buffer programmatically.

  Parameters

  Info

  • Access: public
  
  
• void setCharAt()
  
  Usage: setCharAt ( $offset, $char )
  
  

  Changes the value of the character at the passed offset

  Parameters

  • offset $offset - The location to replace. @
  • char $char - The character to insert at the offset. @

  Info

  • Access: public
  • Throws: Exception @
  
  
• void setLength()
  
  Usage: setLength ( $len )
  
  

  Changes the length of the buffer, to accomodate more characters

  Parameters

  • len 1 - Clip or Grow the current amound of indices in the buffer
  • len $len - The new length of the buffer. @

  Info

  • Access: public
  
  
• char[] subSequence()
  
  Usage: subSequence ( $start, $end )
  
  

  Return a portion of the current buffer as an array.

  Parameters

  • start $start - index to start at @
  • end $end - index to end at @

  Info

  • Return: A portion of the current buffer in char[] array format
  • Access: public
  
  
• String substring()
  
  Usage: substring ( $start, [$end = -1] )
  
  

  Return a portion of the buffer, between the starting and ending offsets

  Parameters

  • start $start - The starting offset. @
  • end $end - The ending offset @

  Info

  • Return: A portion of the current buffer in String format @
  • Access: public
  
  
• String toString()
  
  Usage: toString ( )
  
  

  Overrides: Object::toString()

  Returns a string representation of the completed buffer

  Parameters

  Info

  • Return: @
  • Throws: Exception @
  • Access: public
  
  
• void __construct()
  
  Usage: __construct ( $initChar )
  
  

  Constructor. Takes initial char buffer as a parameter.

  Parameters

  • initChar $initChar - The initial value of the buffer

  Info