old-autovect-branch/libjava/classpath/org/omg/CORBA/StringSeqHelper.java

   1 /* StringSeqHelper.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.CORBA;
  40
  41 import gnu.CORBA.typecodes.ArrayTypeCode;
  42
  43 import org.omg.CORBA.TypeCodePackage.BadKind;
  44 import org.omg.CORBA.portable.InputStream;
  45 import org.omg.CORBA.portable.OutputStream;
  46
  47 /**
  48  * Provides static helper methods for working with
  49  * CORBA <code>string</code> array.
  50  *
  51  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  52  */
  53 public abstract class StringSeqHelper
  54 {
  55   /**
  56    * Extract the <code>String[]</code> from the
  57    * given {@link Any}. This implementation expects the
  58    * {@link Any} to hold the instance of {@link StringSeqHolder}
  59    * that is returned by {@link Any#extract_Streamable() }.
  60    *
  61    * @param a an Any to extract the array from.
  62    *
  63    * @return the extracted array.
  64    *
  65    * @throws ClassCastException if the Any contains something other than the
  66    * the {@link StringSeqHolder}.
  67    */
  68   public static String[] extract(Any a)
  69   {
  70     StringSeqHolder h = (StringSeqHolder) a.extract_Streamable();
  71     return h.value;
  72   }
  73
  74   /**
  75    * Returns the agreed Id, delegating functionality to
  76    * the {@link #type()}.id().
  77    */
  78   public static String id()
  79   {
  80     try
  81       {
  82         return type().id();
  83       }
  84     catch (BadKind ex)
  85       {
  86         // Should never happen under correct work.
  87         throw new Error("Please report this bug.", ex);
  88       }
  89   }
  90
  91   /**
  92   * Insert into the given <code>String[]</code> into the
  93   * given {@link Any}. This implementation first creates
  94   * a {@link StringSeqHolder} and then calls
  95   * {@link Any#insert_Streamable(Streamable)}.
  96   *
  97   * @param into the target Any.
  98   * @param that the array to insert.
  99   */
 100   public static void insert(Any into, String[] that)
 101   {
 102     StringSeqHolder holder = new StringSeqHolder(that);
 103     into.insert_Streamable(holder);
 104   }
 105
 106   /**
 107    * Reads the <code>String[]</code> from the CORBA input stream.
 108    *
 109    * @param input the CORBA (not java.io) stream to read from.
 110    * @return the value from the stream.
 111    */
 112   public static String[] read(InputStream input)
 113   {
 114     String[] value = new String[ input.read_long() ];
 115     for (int i = 0; i < value.length; i++)
 116       value [ i ] = input.read_string();
 117     return value;
 118   }
 119
 120   /**
 121    * Creates and returns a new instance of the TypeCode,
 122    * corresponding the CORBA <code>string[]</code>.
 123    * The length of the sequence is left with the initial
 124    * value 0.
 125    */
 126   public static TypeCode type()
 127   {
 128     return new ArrayTypeCode(TCKind.tk_string);
 129   }
 130
 131   /**
 132    * Writes the <code>String[]</code> into the given stream.
 133    *
 134    * @param output the CORBA (not java.io) output stream to write.
 135    * @param value the value that must be written.
 136    */
 137   public static void write(OutputStream output, String[] value)
 138   {
 139     output.write_long(value.length);
 140
 141     for (int i = 0; i < value.length; i++)
 142       output.write_string(value [ i ]);
 143   }
 144 }