001/* NVList.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import org.omg.CORBA.Any;
042import org.omg.CORBA.Bounds;
043import org.omg.CORBA.NamedValue;
044
045/**
046 * The named value list, used to define the parameters in the
047 * {@link org.omg.CORBA.Request}. This class is also
048 * used to hold the values of {@link Context}.
049 *
050 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
051 */
052public abstract class NVList
053{
054  /**
055   * Create and add a new named value object with null name,
056   * null value and having given flags.
057   * @param a_flags the flags, the normally expected values are
058   * {@link org.omg.CORBA.ARG_IN#value}, 
059   * {@link org.omg.CORBA.ARG_OUT#value} and 
060   * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
061   * 
062   * @return the created and added value.
063   */
064  public abstract NamedValue add(int a_flags);
065
066  /**
067   * Create and add the new named value object with the given
068   * names, given flags and the null value.
069   * @param a_name the name
070   * @param a_flags the flags, the normally expected values are
071   * {@link org.omg.CORBA.ARG_IN#value},
072   * {@link org.omg.CORBA.ARG_OUT#value} and
073   * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
074   * 
075   * @return the created and added value.
076   */
077  public abstract NamedValue add_item(String a_name, int a_flags);
078
079  /**
080   * Create and add the named value object with the given name,
081   * value and flags.
082   * @param a_name the name
083   * @param a_value the value
084   * @param a_flags the flags, the normally expected values are
085   * {@link org.omg.CORBA.ARG_IN#value},
086   * {@link org.omg.CORBA.ARG_OUT#value} and
087   * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
088   * 
089   * @return the created object.
090   */
091  public abstract NamedValue add_value(String a_name, Any a_value, int a_flags);
092
093  /**
094   * Get the number of the present named value pairs.
095   * 
096   * @return the number of objects in the list.
097   */
098  public abstract int count();
099
100  /**
101   * Get the item at the given index
102   * @param at the index.
103   * 
104   * @return the item at the index
105   * @throws Bounds if the index is out of bounds.
106   */
107  public abstract NamedValue item(int at)
108                           throws Bounds;
109
110  /**
111   * Remove the item at the given index
112   * @param at the index
113   * @throws Bounds if the index is out of bounds.
114   */
115  public abstract void remove(int at)
116                       throws Bounds;
117}