Source for org.omg.CORBA.FieldNameHelper

   1: /* FieldNameHelper.java --
   2:    Copyright (C) 2005, 2006 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.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 formal helper for the CORBA FieldName that is identical to the
  51:  * narrow string.
  52:  *
  53:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  54:  */
  55: public abstract class FieldNameHelper
  56: {
  57:   /**
  58:    * Insert the FieldName into Any (uses {@link Any#insert_string}).
  59:    *
  60:    * @param a the Any to insert into.
  61:    * @param that the string to insert.
  62:    */
  63:   public static void insert(Any a, String that)
  64:   {
  65:     a.insert_string(that);
  66:   }
  67: 
  68:   /**
  69:    * Extract the FieldName from Any ((uses {@link Any#extract_string}).
  70:    *
  71:    * @param a the Any to extract from.
  72:    */
  73:   public static String extract(Any a)
  74:   {
  75:     return a.extract_string();
  76:   }
  77: 
  78:   /**
  79:    * Return an string alias typecode, named "FieldName".
  80:    */
  81:   public static TypeCode type()
  82:   {
  83:     ORB orb = OrbRestricted.Singleton;
  84:     return orb.create_alias_tc(id(), "FieldName", orb.create_string_tc(0));
  85:   }
  86: 
  87:   /**
  88:    * Return the FieldName repository id.
  89:    * @return "IDL:omg.org/CORBA/FieldName:1.0", always.
  90:    */
  91:   public static String id()
  92:   {
  93:     return "IDL:omg.org/CORBA/FieldName:1.0";
  94:   }
  95: 
  96:   /**
  97:    * Calls {@link InputStream#read_string()}.
  98:    *
  99:    * @param istream the stream to read from.
 100:    */
 101:   public static String read(InputStream istream)
 102:   {
 103:     return istream.read_string();
 104:   }
 105: 
 106:   /**
 107:    * Calls {@link OutputStream#write_string(String)}.
 108:    *
 109:    * @param ostream the stream to write into.
 110:    * @param value the string (FieldName) value to write.
 111:    */
 112:   public static void write(OutputStream ostream, String value)
 113:   {
 114:     ostream.write_string(value);
 115:   }