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