001    /* CharSeqHelper.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.CORBA;
040    
041    import gnu.CORBA.typecodes.ArrayTypeCode;
042    
043    import org.omg.CORBA.TypeCodePackage.BadKind;
044    import org.omg.CORBA.portable.InputStream;
045    import org.omg.CORBA.portable.OutputStream;
046    import org.omg.CORBA.portable.Streamable;
047    
048    /**
049     * Provides static helper methods for working with
050     * CORBA sequence of <code>char</code>
051     * (<code>CharSeq</code>).
052     *
053     * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
054     */
055    public abstract class CharSeqHelper
056    {
057      /**
058       * Extract the <code>char[]</code> from the
059       * given {@link Any}. This implementation expects the
060       * {@link Any} to hold the instance of {@link CharSeqHolder}
061       * that is returned by {@link Any#extract_Streamable() }.
062       *
063       * @param a an Any to extract the array from.
064       *
065       * @return the extracted array.
066       *
067       * @throws ClassCastException if the Any contains something other than the
068       * the {@link CharSeqHolder}.
069       */
070      public static char[] extract(Any a)
071      {
072        CharSeqHolder h = (CharSeqHolder) a.extract_Streamable();
073        return h.value;
074      }
075    
076      /**
077       * Returns the agreed Id, delegating functionality to
078       * the {@link #type()}.id().
079       */
080      public static String id()
081      {
082        try
083          {
084            return type().id();
085          }
086        catch (BadKind ex)
087          {
088            // Should never happen under correct work.
089            throw new Error("Please report this bug.", ex);
090          }
091      }
092    
093      /**
094      * Insert into the given <code>char[]</code> into the
095      * given {@link Any}. This implementation first creates
096      * a {@link CharSeqHolder} and then calls
097      * {@link Any#insert_Streamable(Streamable)}.
098      *
099      * @param into the target Any.
100      * @param that the array to insert.
101      */
102      public static void insert(Any into, char[] that)
103      {
104        CharSeqHolder holder = new CharSeqHolder(that);
105        into.insert_Streamable(holder);
106      }
107    
108      /**
109       * Reads the <code>char[]</code> from the CORBA input stream.
110       *
111       * @param input the CORBA (not java.io) stream to read from.
112       * @return the value from the stream.
113       */
114      public static char[] read(InputStream input)
115      {
116        char [] value = new char[ input.read_long() ];
117        input.read_char_array(value, 0, value.length);
118        return value;
119      }
120    
121      /**
122       * Creates and returns a new instance of the TypeCode,
123       * corresponding the CORBA <code>CharSeq</code>.
124       * The length of the sequence is left with the initial
125       * value 0.
126       */
127      public static TypeCode type()
128      {
129        return new ArrayTypeCode(TCKind.tk_char);
130      }
131    
132      /**
133       * Writes the <code>char[]</code> into the given stream.
134       *
135       * @param output the CORBA (not java.io) output stream to write.
136       * @param value the value that must be written.
137       */
138      public static void write(OutputStream output, char[] value)
139      {
140        output.write_long(value.length);
141        output.write_char_array(value, 0, value.length);
142      }
143    }