src/share/classes/org/omg/CORBA/DataInputStream.java

Tue, 25 Mar 2008 14:42:28 -0700

author
ohair
date
Tue, 25 Mar 2008 14:42:28 -0700
changeset 5
5e61d5df6258
parent 1
55540e827aef
child 158
91006f157c46
permissions
-rw-r--r--

6627817: Remove ^M characters in all files (Makefiles too)
Summary: Some files included the use of the ^M character, which has been deleted
Reviewed-by: xdono

duke@1 1 /*
duke@1 2 * Copyright 1998-1999 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package org.omg.CORBA;
duke@1 27
duke@1 28 /** Defines the methods used to read primitive data types from input streams
duke@1 29 * for unmarshaling custom value types. This interface is used by user
duke@1 30 * written custom unmarshaling code for custom value types.
duke@1 31 * @see org.omg.CORBA.DataOutputStream
duke@1 32 * @see org.omg.CORBA.CustomMarshal
duke@1 33 */
duke@1 34 public interface DataInputStream extends org.omg.CORBA.portable.ValueBase
duke@1 35 {
duke@1 36 /** Reads an IDL <code>Any</code> value from the input stream.
duke@1 37 * @return the <code>Any</code> read.
duke@1 38 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 39 * If an inconsistency is detected, including not having registered
duke@1 40 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 41 */
duke@1 42 org.omg.CORBA.Any read_any ();
duke@1 43
duke@1 44 /** Reads an IDL boolean value from the input stream.
duke@1 45 * @return the boolean read.
duke@1 46 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 47 * If an inconsistency is detected, including not having registered
duke@1 48 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 49 */
duke@1 50 boolean read_boolean ();
duke@1 51
duke@1 52 /** Reads an IDL character value from the input stream.
duke@1 53 * @return the character read.
duke@1 54 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 55 * If an inconsistency is detected, including not having registered
duke@1 56 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 57 */
duke@1 58 char read_char ();
duke@1 59
duke@1 60 /** Reads an IDL wide character value from the input stream.
duke@1 61 * @return the wide character read.
duke@1 62 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 63 * If an inconsistency is detected, including not having registered
duke@1 64 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 65 */
duke@1 66 char read_wchar ();
duke@1 67
duke@1 68 /** Reads an IDL octet value from the input stream.
duke@1 69 * @return the octet value read.
duke@1 70 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 71 * If an inconsistency is detected, including not having registered
duke@1 72 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 73 */
duke@1 74 byte read_octet ();
duke@1 75
duke@1 76 /** Reads an IDL short from the input stream.
duke@1 77 * @return the short read.
duke@1 78 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 79 * If an inconsistency is detected, including not having registered
duke@1 80 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 81 */
duke@1 82 short read_short ();
duke@1 83
duke@1 84 /** Reads an IDL unsigned short from the input stream.
duke@1 85 * @return the unsigned short read.
duke@1 86 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 87 * If an inconsistency is detected, including not having registered
duke@1 88 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 89 */
duke@1 90 short read_ushort ();
duke@1 91
duke@1 92 /** Reads an IDL long from the input stream.
duke@1 93 * @return the long read.
duke@1 94 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 95 * If an inconsistency is detected, including not having registered
duke@1 96 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 97 */
duke@1 98 int read_long ();
duke@1 99
duke@1 100 /** Reads an IDL unsigned long from the input stream.
duke@1 101 * @return the unsigned long read.
duke@1 102 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 103 * If an inconsistency is detected, including not having registered
duke@1 104 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 105 */
duke@1 106 int read_ulong ();
duke@1 107
duke@1 108 /** Reads an IDL long long from the input stream.
duke@1 109 * @return the long long read.
duke@1 110 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 111 * If an inconsistency is detected, including not having registered
duke@1 112 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 113 */
duke@1 114 long read_longlong ();
duke@1 115
duke@1 116 /** Reads an unsigned IDL long long from the input stream.
duke@1 117 * @return the unsigned long long read.
duke@1 118 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 119 * If an inconsistency is detected, including not having registered
duke@1 120 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 121 */
duke@1 122 long read_ulonglong ();
duke@1 123
duke@1 124 /** Reads an IDL float from the input stream.
duke@1 125 * @return the float read.
duke@1 126 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 127 * If an inconsistency is detected, including not having registered
duke@1 128 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 129 */
duke@1 130 float read_float ();
duke@1 131
duke@1 132 /** Reads an IDL double from the input stream.
duke@1 133 * @return the double read.
duke@1 134 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 135 * If an inconsistency is detected, including not having registered
duke@1 136 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 137 */
duke@1 138 double read_double ();
duke@1 139 // read_longdouble not supported by IDL/Java mapping
duke@1 140
duke@1 141 /** Reads an IDL string from the input stream.
duke@1 142 * @return the string read.
duke@1 143 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 144 * If an inconsistency is detected, including not having registered
duke@1 145 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 146 */
duke@1 147 String read_string ();
duke@1 148
duke@1 149 /** Reads an IDL wide string from the input stream.
duke@1 150 * @return the wide string read.
duke@1 151 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 152 * If an inconsistency is detected, including not having registered
duke@1 153 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 154 */
duke@1 155 String read_wstring ();
duke@1 156
duke@1 157 /** Reads an IDL CORBA::Object from the input stream.
duke@1 158 * @return the CORBA::Object read.
duke@1 159 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 160 * If an inconsistency is detected, including not having registered
duke@1 161 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 162 */
duke@1 163 org.omg.CORBA.Object read_Object ();
duke@1 164
duke@1 165 /** Reads an IDL Abstract interface from the input stream.
duke@1 166 * @return the Abstract interface read.
duke@1 167 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 168 * If an inconsistency is detected, including not having registered
duke@1 169 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 170 */
duke@1 171 java.lang.Object read_Abstract ();
duke@1 172
duke@1 173 /** Reads an IDL value type from the input stream.
duke@1 174 * @return the value type read.
duke@1 175 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 176 * If an inconsistency is detected, including not having registered
duke@1 177 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 178 */
duke@1 179 java.io.Serializable read_Value ();
duke@1 180
duke@1 181 /** Reads an IDL typecode from the input stream.
duke@1 182 * @return the typecode read.
duke@1 183 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 184 * If an inconsistency is detected, including not having registered
duke@1 185 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 186 */
duke@1 187 org.omg.CORBA.TypeCode read_TypeCode ();
duke@1 188
duke@1 189 /** Reads array of IDL Anys from offset for length elements from the
duke@1 190 * input stream.
duke@1 191 * @param seq The out parameter holder for the array to be read.
duke@1 192 * @param offset The index into seq of the first element to read from the
duke@1 193 * input stream.
duke@1 194 * @param length The number of elements to read from the input stream.
duke@1 195 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 196 * If an inconsistency is detected, including not having registered
duke@1 197 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 198 */
duke@1 199 void read_any_array (org.omg.CORBA.AnySeqHolder seq, int offset, int length);
duke@1 200
duke@1 201 /** Reads array of IDL booleans from offset for length elements from the
duke@1 202 * input stream.
duke@1 203 * @param seq The out parameter holder for the array to be read.
duke@1 204 * @param offset The index into seq of the first element to read from the
duke@1 205 * input stream.
duke@1 206 * @param length The number of elements to read from the input stream.
duke@1 207 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 208 * If an inconsistency is detected, including not having registered
duke@1 209 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 210 */
duke@1 211 void read_boolean_array (org.omg.CORBA.BooleanSeqHolder seq, int offset, int length);
duke@1 212
duke@1 213 /** Reads array of IDL characters from offset for length elements from the
duke@1 214 * input stream.
duke@1 215 * @param seq The out parameter holder for the array to be read.
duke@1 216 * @param offset The index into seq of the first element to read from the
duke@1 217 * input stream.
duke@1 218 * @param length The number of elements to read from the input stream.
duke@1 219 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 220 * If an inconsistency is detected, including not having registered
duke@1 221 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 222 */
duke@1 223 void read_char_array (org.omg.CORBA.CharSeqHolder seq, int offset, int length);
duke@1 224
duke@1 225 /** Reads array of IDL wide characters from offset for length elements from the
duke@1 226 * input stream.
duke@1 227 * @param seq The out parameter holder for the array to be read.
duke@1 228 * @param offset The index into seq of the first element to read from the
duke@1 229 * input stream.
duke@1 230 * @param length The number of elements to read from the input stream.
duke@1 231 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 232 * If an inconsistency is detected, including not having registered
duke@1 233 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 234 */
duke@1 235 void read_wchar_array (org.omg.CORBA.WCharSeqHolder seq, int offset, int length);
duke@1 236
duke@1 237 /** Reads array of IDL octets from offset for length elements from the
duke@1 238 * input stream.
duke@1 239 * @param seq The out parameter holder for the array to be read.
duke@1 240 * @param offset The index into seq of the first element to read from the
duke@1 241 * input stream.
duke@1 242 * @param length The number of elements to read from the input stream.
duke@1 243 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 244 * If an inconsistency is detected, including not having registered
duke@1 245 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 246 */
duke@1 247 void read_octet_array (org.omg.CORBA.OctetSeqHolder seq, int offset, int length);
duke@1 248
duke@1 249 /** Reads array of IDL shorts from offset for length elements from the
duke@1 250 * input stream.
duke@1 251 * @param seq The out parameter holder for the array to be read.
duke@1 252 * @param offset The index into seq of the first element to read from the
duke@1 253 * input stream.
duke@1 254 * @param length The number of elements to read from the input stream.
duke@1 255 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 256 * If an inconsistency is detected, including not having registered
duke@1 257 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 258 */
duke@1 259 void read_short_array (org.omg.CORBA.ShortSeqHolder seq, int offset, int length);
duke@1 260
duke@1 261 /** Reads array of IDL unsigned shorts from offset for length elements from the
duke@1 262 * input stream.
duke@1 263 * @param seq The out parameter holder for the array to be read.
duke@1 264 * @param offset The index into seq of the first element to read from the
duke@1 265 * input stream.
duke@1 266 * @param length The number of elements to read from the input stream.
duke@1 267 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 268 * If an inconsistency is detected, including not having registered
duke@1 269 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 270 */
duke@1 271 void read_ushort_array (org.omg.CORBA.UShortSeqHolder seq, int offset, int length);
duke@1 272
duke@1 273 /** Reads array of IDL longs from offset for length elements from the
duke@1 274 * input stream.
duke@1 275 * @param seq The out parameter holder for the array to be read.
duke@1 276 * @param offset The index into seq of the first element to read from the
duke@1 277 * input stream.
duke@1 278 * @param length The number of elements to read from the input stream.
duke@1 279 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 280 * If an inconsistency is detected, including not having registered
duke@1 281 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 282 */
duke@1 283 void read_long_array (org.omg.CORBA.LongSeqHolder seq, int offset, int length);
duke@1 284
duke@1 285 /** Reads array of IDL unsigned longs from offset for length elements from the
duke@1 286 * input stream.
duke@1 287 * @param seq The out parameter holder for the array to be read.
duke@1 288 * @param offset The index into seq of the first element to read from the
duke@1 289 * input stream.
duke@1 290 * @param length The number of elements to read from the input stream.
duke@1 291 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 292 * If an inconsistency is detected, including not having registered
duke@1 293 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 294 */
duke@1 295 void read_ulong_array (org.omg.CORBA.ULongSeqHolder seq, int offset, int length);
duke@1 296
duke@1 297 /** Reads array of IDL unsigned long longs from offset for length elements from the
duke@1 298 * input stream.
duke@1 299 * @param seq The out parameter holder for the array to be read.
duke@1 300 * @param offset The index into seq of the first element to read from the
duke@1 301 * input stream.
duke@1 302 * @param length The number of elements to read from the input stream.
duke@1 303 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 304 * If an inconsistency is detected, including not having registered
duke@1 305 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 306 */
duke@1 307 void read_ulonglong_array (org.omg.CORBA.ULongLongSeqHolder seq, int offset, int length);
duke@1 308
duke@1 309 /** Reads array of IDL long longs from offset for length elements from the
duke@1 310 * input stream.
duke@1 311 * @param seq The out parameter holder for the array to be read.
duke@1 312 * @param offset The index into seq of the first element to read from the
duke@1 313 * input stream.
duke@1 314 * @param length The number of elements to read from the input stream.
duke@1 315 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 316 * If an inconsistency is detected, including not having registered
duke@1 317 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 318 */
duke@1 319 void read_longlong_array (org.omg.CORBA.LongLongSeqHolder seq, int offset, int length);
duke@1 320
duke@1 321 /** Reads array of IDL floats from offset for length elements from the
duke@1 322 * input stream.
duke@1 323 * @param seq The out parameter holder for the array to be read.
duke@1 324 * @param offset The index into seq of the first element to read from the
duke@1 325 * input stream.
duke@1 326 * @param length The number of elements to read from the input stream.
duke@1 327 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 328 * If an inconsistency is detected, including not having registered
duke@1 329 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 330 */
duke@1 331 void read_float_array (org.omg.CORBA.FloatSeqHolder seq, int offset, int length);
duke@1 332
duke@1 333 /** Reads array of IDL doubles from offset for length elements from the
duke@1 334 * input stream.
duke@1 335 * @param seq The out parameter holder for the array to be read.
duke@1 336 * @param offset The index into seq of the first element to read from the
duke@1 337 * input stream.
duke@1 338 * @param length The number of elements to read from the input stream.
duke@1 339 * @throws <code>org.omg.CORBA.MARSHAL</code>
duke@1 340 * If an inconsistency is detected, including not having registered
duke@1 341 * a streaming policy, then the standard system exception MARSHAL is raised.
duke@1 342 */
duke@1 343 void read_double_array (org.omg.CORBA.DoubleSeqHolder seq, int offset, int length);
duke@1 344 } // interface DataInputStream

mercurial