Source for org.omg.PortableInterceptor.ORBInitInfoPackage.ObjectIdHelper

   1: /* ObjectIdHelper.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.PortableInterceptor.ORBInitInfoPackage;
  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:  * The Object Id is defined in OMG specification just as a narrow (not wide)
  51:  * string. As such, the Object Id needs no helper, but one is included in
  52:  * the API anyway.
  53:  *
  54:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  55:  */
  56: public abstract class ObjectIdHelper
  57: {
  58:   /**
  59:    * Insert the Object Id into Any (uses {@link Any#insert_string(String)}).
  60:    *
  61:    * @param a the Any to insert into.
  62:    * @param that the string to insert.
  63:    */
  64:   public static void insert(Any a, String that)
  65:   {
  66:     a.insert_string(that);
  67:   }
  68: 
  69:   /**
  70:    * Extract the Object Id from Any (uses {@link Any#extract_string()}).
  71:    *
  72:    * @param a the Any to extract from.
  73:    */
  74:   public static String extract(Any a)
  75:   {
  76:     return a.extract_string();
  77:   }
  78: 
  79:   /**
  80:    * Return an alias typecode.
  81:    */
  82:   public static TypeCode type()
  83:   {
  84:     ORB orb = OrbRestricted.Singleton;
  85:     return orb.create_alias_tc(id(), "ObjectId", orb.create_string_tc(0));
  86:   }
  87: 
  88:   /**
  89:    * Return the Object Id repository id.
  90:    * @return "IDL:omg.org/PortableInterceptor/ORBInitInfo/ObjectId:1.0", always.
  91:    */
  92:   public static String id()
  93:   {
  94:     return "IDL:omg.org/PortableInterceptor/ORBInitInfo/ObjectId:1.0";
  95:   }
  96: 
  97:   /**
  98:    * Calls {@link InputStream#read_string()}.
  99:    *
 100:    * @param input the stream to read from.
 101:    */
 102:   public static String read(InputStream input)
 103:   {
 104:     return input.read_string();
 105:   }
 106: 
 107:   /**
 108:    * Calls {@link OutputStream#write_string(String)}.
 109:    *
 110:    * @param output the stream to write into.
 111:    * @param value the string (Object Id) value to write.
 112:    */
 113:   public static void write(OutputStream output, String value)
 114:   {
 115:     output.write_string(value);
 116:   }