org.LexGrid.LexBIG.DataModel.Collections
Class ExtensionDescriptionList

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

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

Class ExtensionDescriptionList.

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

Constructor Summary
ExtensionDescriptionList()
           
 
Method Summary
 void addExtensionDescription(ExtensionDescription vExtensionDescription)
           
 void addExtensionDescription(int index, ExtensionDescription vExtensionDescription)
           
 java.util.Enumeration<ExtensionDescription> enumerateExtensionDescription()
          Method enumerateExtensionDescription.
 ExtensionDescription[] getExtensionDescription()
          Method getExtensionDescription.Returns the contents of the collection in an Array.
 ExtensionDescription getExtensionDescription(int index)
          Method getExtensionDescription.
 int getExtensionDescriptionCount()
          Method getExtensionDescriptionCount.
 java.util.Iterator<ExtensionDescription> iterateExtensionDescription()
          Method iterateExtensionDescription.
 void removeAllExtensionDescription()
           
 boolean removeExtensionDescription(ExtensionDescription vExtensionDescription)
          Method removeExtensionDescription.
 ExtensionDescription removeExtensionDescriptionAt(int index)
          Method removeExtensionDescriptionAt.
 void setExtensionDescription(ExtensionDescription[] vExtensionDescriptionArray)
           
 void setExtensionDescription(int index, ExtensionDescription vExtensionDescription)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExtensionDescriptionList

public ExtensionDescriptionList()
Method Detail

addExtensionDescription

public void addExtensionDescription(ExtensionDescription vExtensionDescription)
                             throws java.lang.IndexOutOfBoundsException
Parameters:
vExtensionDescription -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addExtensionDescription

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

enumerateExtensionDescription

public java.util.Enumeration<ExtensionDescription> enumerateExtensionDescription()
Method enumerateExtensionDescription.

Returns:
an Enumeration over all possible elements of this collection

getExtensionDescription

public ExtensionDescription getExtensionDescription(int index)
                                             throws java.lang.IndexOutOfBoundsException
Method getExtensionDescription.

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

getExtensionDescription

public ExtensionDescription[] getExtensionDescription()
Method getExtensionDescription.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

getExtensionDescriptionCount

public int getExtensionDescriptionCount()
Method getExtensionDescriptionCount.

Returns:
the size of this collection

iterateExtensionDescription

public java.util.Iterator<ExtensionDescription> iterateExtensionDescription()
Method iterateExtensionDescription.

Returns:
an Iterator over all possible elements in this collection

removeAllExtensionDescription

public void removeAllExtensionDescription()

removeExtensionDescription

public boolean removeExtensionDescription(ExtensionDescription vExtensionDescription)
Method removeExtensionDescription.

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

removeExtensionDescriptionAt

public ExtensionDescription removeExtensionDescriptionAt(int index)
Method removeExtensionDescriptionAt.

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

setExtensionDescription

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

setExtensionDescription

public void setExtensionDescription(ExtensionDescription[] vExtensionDescriptionArray)
Parameters:
vExtensionDescriptionArray -

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.