Source for org.omg.CORBA.NamedValue

   1: /* NamedValue.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: package org.omg.CORBA;
  39: 
  40: /**
  41:  * The class is used to describe a call parameter, having name,
  42:  * value and the passing mode flags ({@link  ARG_IN}, {@link ARG_OUT} or
  43:  * {@link ARG_INOUT}. The same class is also used in {@link Context} to
  44:  * pass the property names and values. This class is normally created by
  45:  * {@link ORB#create_named_value(String, Any, int)}.
  46:  *
  47:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  48:  */
  49: public abstract class NamedValue
  50: {
  51:   /**
  52:    * Get the parameter flags.
  53:    * @return normally one of ({@link  ARG_IN}, {@link ARG_OUT} or
  54:    * {@link ARG_INOUT}).
  55:    */
  56:   public abstract int flags();
  57: 
  58:   /**
  59:    * Get the name of this parameter.
  60:    * @return the name of this instance.
  61:    */
  62:   public abstract String name();
  63: 
  64:   /**
  65:    * Get the value of this parameter. The parameter value is wrapped into
  66:    * the instance of {@link Any}.
  67:    *
  68:    * @return the value of this parameter.
  69:    */
  70:   public abstract Any value();
  71: }