libjava/classpath/org/omg/PortableInterceptor/AdapterNameHelper.java

   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    * The cached typecode, computed once.
  65    */
  66   static TypeCode typecode;
  67
  68   /**
  69    * Extract the adapter name (<code>String[]</code>) from the given {@link Any}.
  70    *
  71    * @param a an Any to extract the array from.
  72    *
  73    * @return the extracted array.
  74    */
  75   public static String[] extract(Any a)
  76   {
  77     StringSeqHolder h = (StringSeqHolder) a.extract_Streamable();
  78     return h.value;
  79   }
  80
  81   /**
  82    * Returns the agreed Id.
  83    *
  84    * @return "IDL:omg.org/PortableInterceptor/AdapterName:1.0", always.
  85    */
  86   public static String id()
  87   {
  88     return "IDL:omg.org/PortableInterceptor/AdapterName:1.0";
  89   }
  90
  91   /**
  92    * Insert into the given adapter name (<code>String[]</code>) into the
  93    * given {@link Any}.
  94    *
  95    * @param into the target Any.
  96    * @param that the array to insert.
  97    */
  98   public static void insert(Any into, String[] that)
  99   {
 100     StringSeqHolder holder = new StringSeqHolder(that);
 101     into.insert_Streamable(holder);
 102     into.type(type());
 103   }
 104
 105   /**
 106    * Reads the <code>String[]</code> from the CORBA input stream.
 107    *
 108    * @param input the CORBA stream to read from.
 109    * @return the value from the stream.
 110    */
 111   public static String[] read(InputStream input)
 112   {
 113     return StringSeqHelper.read(input);
 114   }
 115
 116   /**
 117    * Creates and returns a new instance of the TypeCode,
 118    * corresponding the adapter name.
 119    *
 120    * @return the alias of the string sequence, named "AdapterName".
 121    */
 122   public static TypeCode type()
 123   {
 124     if (typecode == null)
 125       {
 126         ORB orb = OrbRestricted.Singleton;
 127
 128         TypeCode component = orb.create_string_tc(0);
 129         typecode = orb.create_alias_tc(id(), "AdapterName", component);
 130       }
 131     return typecode;
 132   }
 133
 134   /**
 135    * Writes the <code>String[]</code> into the given stream.
 136    *
 137    * @param output the CORBA output stream to write.
 138    * @param value the value that must be written.
 139    */
 140   public static void write(OutputStream output, String[] value)
 141   {
 142     StringSeqHelper.write(output, value);
 143   }
 144 }