Source for org.omg.PortableInterceptor.AdapterNameHelper

   1: /* AdapterNameHelper.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.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.StringSeqHelper;
  46: import org.omg.CORBA.StringSeqHolder;
  47: import org.omg.CORBA.TypeCode;
  48: import org.omg.CORBA.portable.InputStream;
  49: import org.omg.CORBA.portable.OutputStream;
  50: 
  51: /**
  52:  * Provides static helper methods for working with the adapter name helper.
  53:  * The adapter name helper is an array of strings, so {@link StringSeqHelper}
  54:  * could be used for io operations. The separate helper is provided anyway.
  55:  * 
  56:  * @since 1.5
  57:  *
  58:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  59:  */
  60: public abstract class AdapterNameHelper
  61: {
  62:   
  63:   /**
  64:    * Extract the adapter name (<code>String[]</code>) from the given {@link Any}.
  65:    *
  66:    * @param a an Any to extract the array from.
  67:    *
  68:    * @return the extracted array.
  69:    */
  70:   public static String[] extract(Any a)
  71:   {
  72:     StringSeqHolder h = (StringSeqHolder) a.extract_Streamable();
  73:     return h.value;
  74:   }
  75: 
  76:   /**
  77:    * Returns the agreed Id.
  78:    * 
  79:    * @return "IDL:omg.org/PortableInterceptor/AdapterName:1.0", always. 
  80:    */
  81:   public static String id()
  82:   {
  83:     return "IDL:omg.org/PortableInterceptor/AdapterName:1.0";
  84:   }
  85: 
  86:   /**
  87:    * Insert into the given adapter name (<code>String[]</code>) into the
  88:    * given {@link Any}. 
  89:    *
  90:    * @param into the target Any.
  91:    * @param that the array to insert.
  92:    */
  93:   public static void insert(Any into, String[] that)
  94:   {
  95:     StringSeqHolder holder = new StringSeqHolder(that);
  96:     into.insert_Streamable(holder);
  97:     into.type(type());
  98:   }
  99: 
 100:   /**
 101:    * Reads the <code>String[]</code> from the CORBA input stream.
 102:    *
 103:    * @param input the CORBA stream to read from.
 104:    * @return the value from the stream.
 105:    */
 106:   public static String[] read(InputStream input)
 107:   {
 108:     return StringSeqHelper.read(input);
 109:   }
 110: 
 111:   /**
 112:    * Creates and returns a new instance of the TypeCode, corresponding the
 113:    * adapter name.
 114:    * 
 115:    * @return the alias of the string sequence, named "AdapterName".
 116:    */
 117:   public static TypeCode type()
 118:   {
 119:     ORB orb = OrbRestricted.Singleton;
 120: 
 121:     TypeCode component = orb.create_string_tc(0);
 122:     return orb.create_alias_tc(id(), "AdapterName", component);
 123:   }
 124: 
 125:   /**
 126:    * Writes the <code>String[]</code> into the given stream.
 127:    * 
 128:    * @param output the CORBA output stream to write.
 129:    * @param value the value that must be written.
 130:    */
 131:   public static void write(OutputStream output, String[] value)
 132:   {
 133:     StringSeqHelper.write(output, value);
 134:   }
 135: }