001/* StringSeqHolder.java --
002   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import gnu.CORBA.typecodes.ArrayTypeCode;
042
043import org.omg.CORBA.portable.InputStream;
044import org.omg.CORBA.portable.OutputStream;
045import org.omg.CORBA.portable.Streamable;
046
047/**
048 * A sequence holder for CORBA <code>string[]</code> that is mapped into
049 * java <code>String[]</code>.
050 *
051 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
052 */
053public final class StringSeqHolder
054  implements Streamable
055{
056  /**
057   * The <code>String[]</code> (CORBA <code>string[]</code>) value,
058   * held by this StringSeqHolder.
059   */
060  public String[] value;
061
062  /**
063   * The type code for this holder. Each holder has a different instance.
064   */
065  private final ArrayTypeCode typecode =
066    new ArrayTypeCode(TCKind.tk_char);
067
068  /**
069   * Constructs an instance of StringSeqHolder,
070   * initializing {@link #value} to <code>null</code>.
071   */
072  public StringSeqHolder()
073  {
074  }
075
076  /**
077   * Constructs an instance of StringSeqHolder,
078   * initializing {@link #value} to the given <code>String</code>.
079   *
080   * @param initial_value a value that will be assigned to the
081   * {@link #value} field.
082   */
083  public StringSeqHolder(String[] initial_value)
084  {
085    value = initial_value;
086    typecode.setLength(value.length);
087  }
088
089  /**
090   * Fill in the {@link #value } field by reading the required data
091   * from the given stream. This method first reads the array size
092   * (as CORBA <code>long</code>and then all strings.
093   *
094   * @param input the input stream to read from.
095   */
096  public void _read(InputStream input)
097  {
098    value = new String[ input.read_long() ];
099    for (int i = 0; i < value.length; i++)
100      {
101        value [ i ] = input.read_string();
102      }
103    typecode.setLength(value.length);
104  }
105
106  /**
107   * Returns the TypeCode, corresponding the CORBA type that is stored
108   * using this holder.
109   */
110  public TypeCode _type()
111  {
112    return typecode;
113  }
114
115  /**
116   * Write the {@link #value } field to the given stream.
117   * This method first writes the array size
118   * (as CORBA <code>long</code> and then all strings.
119   *
120   * @param output the output stream to write into.
121   */
122  public void _write(OutputStream output)
123  {
124    output.write_long(value.length);
125
126    for (int i = 0; i < value.length; i++)
127      {
128        output.write_string(value [ i ]);
129      }
130  }
131}