org.LexGrid.LexBIG.DataModel.Collections
Class SupportedElementList

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Collections.SupportedElementList
All Implemented Interfaces:
java.io.Serializable

public class SupportedElementList
extends java.lang.Object
implements java.io.Serializable

Class SupportedElementList.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
SupportedElementList()
           
 
Method Summary
 void addSupportedElement(int index, SupportedElement vSupportedElement)
           
 void addSupportedElement(SupportedElement vSupportedElement)
           
 java.util.Enumeration<SupportedElement> enumerateSupportedElement()
          Method enumerateSupportedElement.
 SupportedElement[] getSupportedElement()
          Method getSupportedElement.Returns the contents of the collection in an Array.
 SupportedElement getSupportedElement(int index)
          Method getSupportedElement.
 int getSupportedElementCount()
          Method getSupportedElementCount.
 java.util.Iterator<SupportedElement> iterateSupportedElement()
          Method iterateSupportedElement.
 void removeAllSupportedElement()
           
 boolean removeSupportedElement(SupportedElement vSupportedElement)
          Method removeSupportedElement.
 SupportedElement removeSupportedElementAt(int index)
          Method removeSupportedElementAt.
 void setSupportedElement(int index, SupportedElement vSupportedElement)
           
 void setSupportedElement(SupportedElement[] vSupportedElementArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SupportedElementList

public SupportedElementList()
Method Detail

addSupportedElement

public void addSupportedElement(SupportedElement vSupportedElement)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
vSupportedElement -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSupportedElement

public void addSupportedElement(int index,
                                SupportedElement vSupportedElement)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSupportedElement -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateSupportedElement

public java.util.Enumeration<SupportedElement> enumerateSupportedElement()
Method enumerateSupportedElement.

Returns:
an Enumeration over all possible elements of this collection

getSupportedElement

public SupportedElement getSupportedElement(int index)
                                     throws java.lang.IndexOutOfBoundsException
Method getSupportedElement.

Parameters:
index -
Returns:
the value of the org.LexGrid.LexBIG.DataModel.Core.SupportedElement at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getSupportedElement

public SupportedElement[] getSupportedElement()
Method getSupportedElement.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getSupportedElementCount

public int getSupportedElementCount()
Method getSupportedElementCount.

Returns:
the size of this collection

iterateSupportedElement

public java.util.Iterator<SupportedElement> iterateSupportedElement()
Method iterateSupportedElement.

Returns:
an Iterator over all possible elements in this collection

removeAllSupportedElement

public void removeAllSupportedElement()

removeSupportedElement

public boolean removeSupportedElement(SupportedElement vSupportedElement)
Method removeSupportedElement.

Parameters:
vSupportedElement -
Returns:
true if the object was removed from the collection.

removeSupportedElementAt

public SupportedElement removeSupportedElementAt(int index)
Method removeSupportedElementAt.

Parameters:
index -
Returns:
the element removed from the collection

setSupportedElement

public void setSupportedElement(int index,
                                SupportedElement vSupportedElement)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSupportedElement -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setSupportedElement

public void setSupportedElement(SupportedElement[] vSupportedElementArray)
Parameters:
vSupportedElementArray -

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.