All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.adapters.CharArray

java.lang.Object
   |
   +----COM.objectspace.jgl.adapters.ArrayAdapter
           |
           +----COM.objectspace.jgl.adapters.CharArray

public class CharArray
extends ArrayAdapter
CharArray allows a native array of chars to be accessed like a JGL Container. It is particularly useful for applying generic algorithms such as Sorting.sort() to a native array.


Constructor Index

 o CharArray()
Construct myself to refer to an empty array.
 o CharArray(char[])
Construct myself to refer to a native Java array.
 o CharArray(CharArray)
Construct myself to refer to an existing CharArray.
 o CharArray(CharBuffer)
Construct myself to be a copy of an existing CharBuffer.

Method Index

 o at(int)
Return the integer at the specified index as a Char object.
 o begin()
Return an iterator positioned at my first item.
 o charAt(int)
Return the integer at the specified index as a Char object.
 o clone()
Return a shallow copy of myself.
 o elements()
Return an Enumeration of my components.
 o end()
Return an iterator positioned immediately after my last item.
 o equals(char[])
Return true if I contain the same items in the same order as a native array of chars.
 o equals(CharArray)
Return true if I contain the same items in the same order as another CharArray.
 o equals(CharBuffer)
Return true if I contain the same items in the same order as another CharBuffer.
 o equals(Object)
Return true if I'm equal to a specified object.
 o finish()
Return an iterator positioned immediately after my last item.
 o get()
Retrieve the underlying primitive array.
 o maxSize()
Return the maximum number of objects that I can contain.
 o put(int, char)
Set the value of a specified index.
 o put(int, Object)
Set the object at a specified index.
 o size()
Return the number of objects that I contain.
 o start()
Return an iterator positioned at my first item.
 o toString()
Return a string that describes me.

Constructors

 o CharArray
 public CharArray()
Construct myself to refer to an empty array.

 o CharArray
 public CharArray(CharArray array)
Construct myself to refer to an existing CharArray.

Parameters:
array - The CharArray to copy.
 o CharArray
 public CharArray(CharBuffer buffer)
Construct myself to be a copy of an existing CharBuffer.

Parameters:
array - The CharBuffer to copy.
 o CharArray
 public CharArray(char array[])
Construct myself to refer to a native Java array.

Parameters:
array - The char[] to ape.

Methods

 o clone
 public synchronized Object clone()
Return a shallow copy of myself.

Overrides:
clone in class ArrayAdapter
 o toString
 public synchronized String toString()
Return a string that describes me.

Overrides:
toString in class Object
 o equals
 public boolean equals(Object object)
Return true if I'm equal to a specified object.

Parameters:
object - The object to compare myself against.
Returns:
true if I'm equal to the specified object.
Overrides:
equals in class ArrayAdapter
 o equals
 public boolean equals(CharArray object)
Return true if I contain the same items in the same order as another CharArray.

Parameters:
array - The CharArray to compare myself against.
Returns:
true if I'm equal to the specified object.
 o equals
 public boolean equals(CharBuffer buffer)
Return true if I contain the same items in the same order as another CharBuffer.

Parameters:
buffer - The CharBuffer to compare myself against.
 o equals
 public synchronized boolean equals(char array[])
Return true if I contain the same items in the same order as a native array of chars.

Parameters:
array - The array to compare myself against.
 o get
 public char[] get()
Retrieve the underlying primitive array.

 o size
 public int size()
Return the number of objects that I contain.

Overrides:
size in class ArrayAdapter
 o maxSize
 public int maxSize()
Return the maximum number of objects that I can contain.

Overrides:
maxSize in class ArrayAdapter
 o elements
 public Enumeration elements()
Return an Enumeration of my components.

Overrides:
elements in class ArrayAdapter
 o start
 public ForwardIterator start()
Return an iterator positioned at my first item.

Overrides:
start in class ArrayAdapter
 o begin
 public synchronized CharIterator begin()
Return an iterator positioned at my first item.

 o finish
 public ForwardIterator finish()
Return an iterator positioned immediately after my last item.

Overrides:
finish in class ArrayAdapter
 o end
 public synchronized CharIterator end()
Return an iterator positioned immediately after my last item.

 o at
 public Object at(int index)
Return the integer at the specified index as a Char object.

Parameters:
index - The index.
Overrides:
at in class ArrayAdapter
 o charAt
 public synchronized char charAt(int index)
Return the integer at the specified index as a Char object.

Parameters:
index - The index.
 o put
 public void put(int index,
                 Object object)
Set the object at a specified index. The object must be a Character

Parameters:
index - The index.
object - The object to place at the specified index.
Throws: ClassCastException
if object is not a Character
Throws: IndexOutOfBoundsException
if index is invalid.
Overrides:
put in class ArrayAdapter
 o put
 public synchronized void put(int index,
                              char object)
Set the value of a specified index.

Parameters:
index - The index.
object - The char to place at the specified index.
Throws: IndexOutOfBoundsException
if index is invalid.

All Packages  Class Hierarchy  This Package  Previous  Next  Index