gomp-20050608-branch/libjava/classpath/org/omg/DynamicAny/FieldNameHelper.java

   1 /* FieldNameHelper.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.DynamicAny;
  40
  41 import gnu.CORBA.OrbRestricted;
  42
  43 import org.omg.CORBA.Any;
  44 import org.omg.CORBA.ORB;
  45 import org.omg.CORBA.TypeCode;
  46 import org.omg.CORBA.portable.InputStream;
  47 import org.omg.CORBA.portable.OutputStream;
  48
  49 /**
  50  * A helper for the FieldName.  The fields {@link NameValuePair#id},
  51  * {@link NameDynAnyPair#id} and return values of methods
  52  * <code>current_member_name()</code>, <code>member_name()</code> in several
  53  * interfaces officially have the "FieldName" type. This type is directly
  54  * mapped into java String and needs no helper. The helper
  55  * is included only as a part of the formal standard.
  56  *
  57  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  58  */
  59 public abstract class FieldNameHelper
  60 {
  61   /**
  62    * Insert the FieldName into Any (uses {@link Any.insert_string}).
  63    *
  64    * @param a the Any to insert into.
  65    * @param that the string to insert.
  66    */
  67   public static void insert(Any a, String that)
  68   {
  69     a.insert_string(that);
  70   }
  71
  72   /**
  73    * Extract the FieldName from Any ((uses {@link Any.extract_string}).
  74    *
  75    * @param a the Any to extract from.
  76    */
  77   public static String extract(Any a)
  78   {
  79     return a.extract_string();
  80   }
  81
  82   /**
  83    * Return an alias typecode.
  84    */
  85   public static TypeCode type()
  86   {
  87     ORB orb = OrbRestricted.Singleton;
  88     return orb.create_alias_tc(id(), "FieldName", orb.create_string_tc(0));
  89   }
  90
  91   /**
  92    * Return the FieldName repository id.
  93    * @return "IDL:omg.org/DynamicAny/FieldName:1.0", always.
  94    */
  95   public static String id()
  96   {
  97     return "IDL:omg.org/DynamicAny/FieldName:1.0";
  98   }
  99
 100   /**
 101    * Calls {@link InputStream#read_string()}.
 102    *
 103    * @param instream the stream to read from.
 104    */
 105   public static String read(InputStream istream)
 106   {
 107     return istream.read_string();
 108   }
 109
 110   /**
 111    * Calls {@link OutputStream#write_string()}.
 112    *
 113    * @param ostream the stream to write into.
 114    * @param value the string (FieldName) value to write.
 115    */
 116   public static void write(OutputStream ostream, String value)
 117   {
 118     ostream.write_string(value);
 119   }
 120 }