Source for org.omg.CORBA.ParameterModeHelper

   1: /* ParameterModeHelper.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 gnu.CORBA.OrbRestricted;
  42: 
  43: import org.omg.CORBA.portable.InputStream;
  44: import org.omg.CORBA.portable.OutputStream;
  45: 
  46: /**
  47:  * A helper operations for a method parameter modes.
  48:  * A method parameter can pass the value (PARAM_IN), be used as a placeholder
  49:  * to return the value (PARAM_OUT) or both pass the data and be used as a
  50:  * placeholder to return the changed value (PARAM_INOUT).
  51:  *
  52:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  53:  */
  54: public abstract class ParameterModeHelper
  55: {
  56:   /**
  57:    * The cached typecode value, computed only once.
  58:    */
  59:   private static TypeCode typeCode;
  60: 
  61:   /**
  62:    * Insert the parameter mode into the given Any.
  63:    */
  64:   public static void insert(Any any, ParameterMode that)
  65:   {
  66:     any.insert_Streamable(new ParameterModeHolder(that));
  67:   }
  68: 
  69:   /**
  70:    * Extract the parameter mode from the given Any.
  71:    */
  72:   public static ParameterMode extract(Any any)
  73:   {
  74:     return ((ParameterModeHolder) any.extract_Streamable()).value;
  75:   }
  76: 
  77:   /**
  78:    * Get the parameter mode typecode (enumeration, named "ParameterMode").
  79:    * The typecode states that the enumeration can obtain one of
  80:    * the following values: PARAM_IN ,PARAM_OUT ,PARAM_INOUT .
  81:    */
  82:   public static TypeCode type()
  83:   {
  84:     if (typeCode == null)
  85:       {
  86:         String[] members =
  87:           new String[] { "PARAM_IN", "PARAM_OUT", "PARAM_INOUT" };
  88: 
  89:         typeCode =
  90:           OrbRestricted.Singleton.create_enum_tc(id(), "ParameterMode", members);
  91:       }
  92:     return typeCode;
  93:   }
  94: 
  95:   /**
  96:    * Get the parameter mode repository id.
  97:    *
  98:    * @return "IDL:omg.org/CORBA/ParameterMode:1.0", always.
  99:    */
 100:   public static String id()
 101:   {
 102:     return "IDL:omg.org/CORBA/ParameterMode:1.0";
 103:   }
 104: 
 105:   /**
 106:    * Read the enumeration value (as int) from the CDR intput stream.
 107:    *
 108:    * @param istream a stream to read from.
 109:    */
 110:   public static ParameterMode read(InputStream istream)
 111:   {
 112:     return ParameterMode.from_int(istream.read_long());
 113:   }
 114: 
 115:   /**
 116:    * Write the enumeration value (as int) to the CDR output stream.
 117:    *
 118:    * @param ostream a stream to write into.
 119:    * @param value a value to write.
 120:    */
 121:   public static void write(OutputStream ostream, ParameterMode value)
 122:   {
 123:     ostream.write_long(value.value());
 124:   }