001    /* NVList.java --
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.CORBA;
040    
041    import org.omg.CORBA.Any;
042    import org.omg.CORBA.Bounds;
043    import 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     */
052    public 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    }