Source for org.omg.CORBA.NVList

   1: /* NVList.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.CORBA;
  40: 
  41: import org.omg.CORBA.Any;
  42: import org.omg.CORBA.Bounds;
  43: import org.omg.CORBA.NamedValue;
  44: 
  45: /**
  46:  * The named value list, used to define the parameters in the
  47:  * {@link org.omg.CORBA.Request}. This class is also
  48:  * used to hold the values of {@link Context}.
  49:  *
  50:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  51:  */
  52: public abstract class NVList
  53: {
  54:   /**
  55:    * Create and add a new named value object with null name,
  56:    * null value and having given flags.
  57:    * @param a_flags the flags, the normally expected values are
  58:    * {@link org.omg.CORBA.ARG_IN#value}, 
  59:    * {@link org.omg.CORBA.ARG_OUT#value} and 
  60:    * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
  61:    * 
  62:    * @return the created and added value.
  63:    */
  64:   public abstract NamedValue add(int a_flags);
  65: 
  66:   /**
  67:    * Create and add the new named value object with the given
  68:    * names, given flags and the null value.
  69:    * @param a_name the name
  70:    * @param a_flags the flags, the normally expected values are
  71:    * {@link org.omg.CORBA.ARG_IN#value},
  72:    * {@link org.omg.CORBA.ARG_OUT#value} and
  73:    * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
  74:    * 
  75:    * @return the created and added value.
  76:    */
  77:   public abstract NamedValue add_item(String a_name, int a_flags);
  78: 
  79:   /**
  80:    * Create and add the named value object with the given name,
  81:    * value and flags.
  82:    * @param a_name the name
  83:    * @param a_value the value
  84:    * @param a_flags the flags, the normally expected values are
  85:    * {@link org.omg.CORBA.ARG_IN#value},
  86:    * {@link org.omg.CORBA.ARG_OUT#value} and
  87:    * {@link org.omg.CORBA.ARG_INOUT#value} or 0.
  88:    * 
  89:    * @return the created object.
  90:    */
  91:   public abstract NamedValue add_value(String a_name, Any a_value, int a_flags);
  92: 
  93:   /**
  94:    * Get the number of the present named value pairs.
  95:    * 
  96:    * @return the number of objects in the list.
  97:    */
  98:   public abstract int count();
  99: 
 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: }