org.LexGrid.LexBIG.DataModel.Collections
Class LocalNameList

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

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

Class LocalNameList.

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

Constructor Summary
LocalNameList()
           
 
Method Summary
 void addEntry(int index, java.lang.String vEntry)
           
 void addEntry(java.lang.String vEntry)
           
 java.util.Enumeration<java.lang.String> enumerateEntry()
          Method enumerateEntry.
 java.lang.String[] getEntry()
          Method getEntry.Returns the contents of the collection in an Array.
 java.lang.String getEntry(int index)
          Method getEntry.
 int getEntryCount()
          Method getEntryCount.
 java.util.Iterator<java.lang.String> iterateEntry()
          Method iterateEntry.
 void removeAllEntry()
           
 boolean removeEntry(java.lang.String vEntry)
          Method removeEntry.
 java.lang.String removeEntryAt(int index)
          Method removeEntryAt.
 void setEntry(int index, java.lang.String vEntry)
           
 void setEntry(java.lang.String[] vEntryArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocalNameList

public LocalNameList()
Method Detail

addEntry

public void addEntry(java.lang.String vEntry)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vEntry -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntry

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

enumerateEntry

public java.util.Enumeration<java.lang.String> enumerateEntry()
Method enumerateEntry.

Returns:
an Enumeration over all possible elements of this collection

getEntry

public java.lang.String getEntry(int index)
                          throws java.lang.IndexOutOfBoundsException
Method getEntry.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getEntry

public java.lang.String[] getEntry()
Method getEntry.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

getEntryCount

public int getEntryCount()
Method getEntryCount.

Returns:
the size of this collection

iterateEntry

public java.util.Iterator<java.lang.String> iterateEntry()
Method iterateEntry.

Returns:
an Iterator over all possible elements in this collection

removeAllEntry

public void removeAllEntry()

removeEntry

public boolean removeEntry(java.lang.String vEntry)
Method removeEntry.

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

removeEntryAt

public java.lang.String removeEntryAt(int index)
Method removeEntryAt.

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

setEntry

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

setEntry

public void setEntry(java.lang.String[] vEntryArray)
Parameters:
vEntryArray -

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.