/*
 * This class was automatically generated with
 * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML
 * Schema.
 * $Id$
 */

package jalview.binding;

//---------------------------------/
//- Imported classes and packages -/
//---------------------------------/

import java.util.*;

/**
 * Class JalviewModelSequence2Item.
 *
 * @version $Revision$ $Date$
 */
public class JalviewModelSequence2Item
    implements java.io.Serializable
{

  //--------------------------/
  //- Class/Member Variables -/
  //--------------------------/

  /**
   * Field _userColourSchemeList
   */
  private java.util.Vector _userColourSchemeList;

  //----------------/
  //- Constructors -/
  //----------------/

  public JalviewModelSequence2Item()
  {
    super();
    _userColourSchemeList = new Vector();
  } //-- jalview.binding.JalviewModelSequence2Item()

  //-----------/
  //- Methods -/
  //-----------/

  /**
   * Method addUserColourScheme
   *
   *
   *
   * @param vUserColourScheme
   */
  public void addUserColourScheme(jalview.binding.UserColourScheme
                                  vUserColourScheme)
      throws java.lang.IndexOutOfBoundsException
  {
    _userColourSchemeList.addElement(vUserColourScheme);
  } //-- void addUserColourScheme(jalview.binding.UserColourScheme)

  /**
   * Method addUserColourScheme
   *
   *
   *
   * @param index
   * @param vUserColourScheme
   */
  public void addUserColourScheme(int index,
                                  jalview.binding.UserColourScheme
                                  vUserColourScheme)
      throws java.lang.IndexOutOfBoundsException
  {
    _userColourSchemeList.insertElementAt(vUserColourScheme, index);
  } //-- void addUserColourScheme(int, jalview.binding.UserColourScheme)

  /**
   * Method enumerateUserColourScheme
   *
   *
   *
   * @return Enumeration
   */
  public java.util.Enumeration enumerateUserColourScheme()
  {
    return _userColourSchemeList.elements();
  } //-- java.util.Enumeration enumerateUserColourScheme()

  /**
   * Method getUserColourScheme
   *
   *
   *
   * @param index
   * @return UserColourScheme
   */
  public jalview.binding.UserColourScheme getUserColourScheme(int index)
      throws java.lang.IndexOutOfBoundsException
  {
    //-- check bounds for index
    if ( (index < 0) || (index > _userColourSchemeList.size()))
    {
      throw new IndexOutOfBoundsException();
    }

    return (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(
        index);
  } //-- jalview.binding.UserColourScheme getUserColourScheme(int)

  /**
   * Method getUserColourScheme
   *
   *
   *
   * @return UserColourScheme
   */
  public jalview.binding.UserColourScheme[] getUserColourScheme()
  {
    int size = _userColourSchemeList.size();
    jalview.binding.UserColourScheme[] mArray = new jalview.binding.
        UserColourScheme[size];
    for (int index = 0; index < size; index++)
    {
      mArray[index] = (jalview.binding.UserColourScheme) _userColourSchemeList.
          elementAt(index);
    }
    return mArray;
  } //-- jalview.binding.UserColourScheme[] getUserColourScheme()

  /**
   * Method getUserColourSchemeCount
   *
   *
   *
   * @return int
   */
  public int getUserColourSchemeCount()
  {
    return _userColourSchemeList.size();
  } //-- int getUserColourSchemeCount()

  /**
   * Method removeAllUserColourScheme
   *
   */
  public void removeAllUserColourScheme()
  {
    _userColourSchemeList.removeAllElements();
  } //-- void removeAllUserColourScheme()

  /**
   * Method removeUserColourScheme
   *
   *
   *
   * @param index
   * @return UserColourScheme
   */
  public jalview.binding.UserColourScheme removeUserColourScheme(int index)
  {
    java.lang.Object obj = _userColourSchemeList.elementAt(index);
    _userColourSchemeList.removeElementAt(index);
    return (jalview.binding.UserColourScheme) obj;
  } //-- jalview.binding.UserColourScheme removeUserColourScheme(int)

  /**
   * Method setUserColourScheme
   *
   *
   *
   * @param index
   * @param vUserColourScheme
   */
  public void setUserColourScheme(int index,
                                  jalview.binding.UserColourScheme
                                  vUserColourScheme)
      throws java.lang.IndexOutOfBoundsException
  {
    //-- check bounds for index
    if ( (index < 0) || (index > _userColourSchemeList.size()))
    {
      throw new IndexOutOfBoundsException();
    }
    _userColourSchemeList.setElementAt(vUserColourScheme, index);
  } //-- void setUserColourScheme(int, jalview.binding.UserColourScheme)

  /**
   * Method setUserColourScheme
   *
   *
   *
   * @param userColourSchemeArray
   */
  public void setUserColourScheme(jalview.binding.UserColourScheme[]
                                  userColourSchemeArray)
  {
    //-- copy array
    _userColourSchemeList.removeAllElements();
    for (int i = 0; i < userColourSchemeArray.length; i++)
    {
      _userColourSchemeList.addElement(userColourSchemeArray[i]);
    }
  } //-- void setUserColourScheme(jalview.binding.UserColourScheme)

}