Source for org.omg.CORBA.ULongLongSeqHelper

   1: /* ULongLongSeqHelper.java --
   2:    Copyright (C) 2005, 2006 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: import org.omg.CORBA.portable.Streamable;
  47: 
  48: /**
  49:  * Provides static helper methods for working with
  50:  * CORBA sequence of <code>long</code>
  51:  * (<code>ULongLongSeq</code>).
  52:  *
  53:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  54:  */
  55: public abstract class ULongLongSeqHelper
  56: {
  57:   /**
  58:    * Extract the <code>long[]</code> from the
  59:    * given {@link Any}. This implementation expects the
  60:    * {@link Any} to hold the instance of {@link ULongLongSeqHolder}
  61:    * that is returned by {@link Any#extract_Streamable() }.
  62:    *
  63:    * @param a an Any to extract the array from.
  64:    *
  65:    * @return the extracted array.
  66:    *
  67:    * @throws ClassCastException if the Any contains something other than the
  68:    * the {@link ULongLongSeqHolder}.
  69:    */
  70:   public static long[] extract(Any a)
  71:   {
  72:     ULongLongSeqHolder h = (ULongLongSeqHolder) a.extract_Streamable();
  73:     return h.value;
  74:   }
  75: 
  76:   /**
  77:    * Returns the agreed Id, delegating functionality to
  78:    * the {@link #type()}.id().
  79:    */
  80:   public static String id()
  81:   {
  82:     try
  83:       {
  84:         return type().id();
  85:       }
  86:     catch (BadKind ex)
  87:       {
  88:         // Should never happen under correct work.
  89:         throw new Error("Please report this bug.", ex);
  90:       }
  91:   }
  92: 
  93:   /**
  94:   * Insert into the given <code>long[]</code> into the
  95:   * given {@link Any}. This implementation first creates
  96:   * a {@link ULongLongSeqHolder} and then calls
  97:   * {@link Any#insert_Streamable(Streamable)}.
  98:   *
  99:   * @param into the target Any.
 100:   * @param that the array to insert.
 101:   */
 102:   public static void insert(Any into, long[] that)
 103:   {
 104:     ULongLongSeqHolder holder = new ULongLongSeqHolder(that);
 105:     into.insert_Streamable(holder);
 106:   }
 107: 
 108:   /**
 109:    * Reads the <code>long[]</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 long[] read(InputStream input)
 115:   {
 116:     long[] value = new long[ input.read_long() ];
 117:     input.read_ulonglong_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>ULongLongSeq</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_ulong);
 130:   }
 131: 
 132:   /**
 133:    * Writes the <code>long[]</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, long[] value)
 139:   {
 140:     output.write_long(value.length);
 141:     output.write_ulonglong_array(value, 0, value.length);
 142:   }
 143: }