Class AbstractCollection

---

Object
   |
   --AbstractCollection

uses: Collection, Object

• Package: util
• Since: Japha 1.0
• Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

• void add()
  
• void addAll()
  
• void clear()
  
• void contains()
  
• void containsAll()
  
• boolean isEmpty()
  
• ListIterator iterator()
  
• void remove()
  
• void removeAll()
  
• void retainAll()
  
• int size()
  
• Object[] toArray()
  
• String toString()
  

Inherited Method Summary

Inherited From Class Object

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

Variable Detail

Method Detail

• void add()
  
  Usage: add ( $object )
  
  

  Add an object to the list

  Parameters

  • object $object - The object to add to the Collection

  Info

  • Access: public
  
  
• void addAll()
  
  Usage: addAll ( $collection )
  
  

  Append a collection to this collection

  Parameters

  • collection $collection - The collection to append @

  Info

  • Access: public
  
  
• void clear()
  
  Usage: clear ( )
  
  

  Clear the current collection. Deletes all elements.

  Parameters

  Info

  • Access: public
  
  
• void contains()
  
  Usage: contains ( $obejct )
  
  

  'Cruise' through the collection, searching for a particular object

  Parameters

  • object $obejct - the item to search for @

  Info

  • Access: public
  
  
• void containsAll()
  
  Usage: containsAll ( $collection )
  
  

  Check if this collection contains all of the elements of the passed collection

  Parameters

  • collection $collection - The collection to search

  Info

  • Access: public
  
  
• boolean isEmpty()
  
  Usage: isEmpty ( )
  
  

  Checks if the current collection has no elements

  Parameters

  Info

  • Return: true iff the collection has no elements
  • Access: public
  
  
• ListIterator iterator()
  
  Usage: iterator ( )
  
  

  Returns an instance of ListIterator to iterate over the current collection

  Parameters

  Info

  • Return: To iterate over the current collection @
  • Abstract Element:
  • Access: public
  
  
• void remove()
  
  Usage: remove ( $object )
  
  

  Removes an element from the collection

  Parameters

  • object $object - the object to remove

  Info

  • Access: public
  
  
• void removeAll()
  
  Usage: removeAll ( $collection )
  
  

  Remove an entire collection from the current collection

  Parameters

  • collection $collection - the collection to remove

  Info

  • Access: public
  
  
• void retainAll()
  
  Usage: retainAll ( $collection )
  
  

  Parameters

  Info

  
  
• int size()
  
  Usage: size ( )
  
  

  Returns the number of elements in the current collection

  Parameters

  Info

  • Return: The number of elements in the collection
  • Abstract Element: @
  • Access: public
  
  
• Object[] toArray()
  
  Usage: toArray ( )
  
  

  Create a normal array out of the current collection

  Parameters

  Info

  • Return: an array of objects contained in the current collection
  • Access: public
  
  
• String toString()
  
  Usage: toString ( )
  
  

  Overrides: Object::toString()

  Convert the current array to a string

  Parameters

  Info

  • Return: the string representation of the collection
  • Access: public