Source for org.omg.PortableInterceptor.ServerIdHelper

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