1. /*

  2.  * @(#)DataInputStream.java	1.6 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. package org.omg.CORBA;

  12. 

  13. /** Defines the methods used to read primitive data types from input streams

  14. * for unmarshaling custom value types.  This interface is used by user

  15. * written custom unmarshaling code for custom value types.

  16. * @see org.omg.CORBA.DataOutputStream

  17. * @see org.omg.CORBA.CustomMarshal

  18. * @version 1.6 02/02/00

  19. */

  20. public interface DataInputStream extends org.omg.CORBA.portable.ValueBase

  21. {

  22.     /** Reads an IDL <code>Any</code> value from the input stream.

  23.     * @return  the <code>Any</code> read.

  24.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  25.     * If an inconsistency is detected, including not having registered 

  26.     * a streaming policy, then the standard system exception MARSHAL is raised.

  27.     */

  28.     org.omg.CORBA.Any read_any ();

  29. 

  30.     /** Reads an IDL boolean value from the input stream.

  31.     * @return  the boolean read.

  32.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  33.     * If an inconsistency is detected, including not having registered 

  34.     * a streaming policy, then the standard system exception MARSHAL is raised.

  35.     */

  36.     boolean read_boolean ();

  37. 

  38.     /** Reads an IDL character value from the input stream.

  39.     * @return  the character read.

  40.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  41.     * If an inconsistency is detected, including not having registered 

  42.     * a streaming policy, then the standard system exception MARSHAL is raised.

  43.     */

  44.     char read_char ();

  45. 

  46.     /** Reads an IDL wide character value from the input stream.

  47.     * @return  the wide character read.

  48.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  49.     * If an inconsistency is detected, including not having registered 

  50.     * a streaming policy, then the standard system exception MARSHAL is raised.

  51.     */

  52.     char read_wchar ();

  53. 

  54.     /** Reads an IDL octet value from the input stream.

  55.     * @return  the octet value read.

  56.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  57.     * If an inconsistency is detected, including not having registered 

  58.     * a streaming policy, then the standard system exception MARSHAL is raised.

  59.     */

  60.     byte read_octet ();

  61. 

  62.     /** Reads an IDL short from the input stream.

  63.     * @return  the short read.

  64.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  65.     * If an inconsistency is detected, including not having registered 

  66.     * a streaming policy, then the standard system exception MARSHAL is raised.

  67.     */

  68.     short read_short ();

  69. 

  70.     /** Reads an IDL unsigned short from the input stream.

  71.     * @return  the unsigned short read.

  72.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  73.     * If an inconsistency is detected, including not having registered 

  74.     * a streaming policy, then the standard system exception MARSHAL is raised.

  75.     */

  76.     short read_ushort ();

  77. 

  78.     /** Reads an IDL long from the input stream.

  79.     * @return  the long read.

  80.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  81.     * If an inconsistency is detected, including not having registered 

  82.     * a streaming policy, then the standard system exception MARSHAL is raised.

  83.     */

  84.     int read_long ();

  85. 

  86.     /** Reads an IDL unsigned long from the input stream.

  87.     * @return  the unsigned long read.

  88.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  89.     * If an inconsistency is detected, including not having registered 

  90.     * a streaming policy, then the standard system exception MARSHAL is raised.

  91.     */

  92.     int read_ulong ();

  93. 

  94.     /** Reads an IDL long long from the input stream.

  95.     * @return  the long long read.

  96.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  97.     * If an inconsistency is detected, including not having registered 

  98.     * a streaming policy, then the standard system exception MARSHAL is raised.

  99.     */

  100.     long read_longlong ();

  101. 

  102.     /** Reads an unsigned IDL long long from the input stream.

  103.     * @return  the unsigned long long read.

  104.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  105.     * If an inconsistency is detected, including not having registered 

  106.     * a streaming policy, then the standard system exception MARSHAL is raised.

  107.     */

  108.     long read_ulonglong ();

  109. 

  110.     /** Reads an IDL float from the input stream.

  111.     * @return  the float read.

  112.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  113.     * If an inconsistency is detected, including not having registered 

  114.     * a streaming policy, then the standard system exception MARSHAL is raised.

  115.     */

  116.     float read_float ();

  117. 

  118.     /** Reads an IDL double from the input stream.

  119.     * @return  the double read.

  120.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  121.     * If an inconsistency is detected, including not having registered 

  122.     * a streaming policy, then the standard system exception MARSHAL is raised.

  123.     */

  124.     double read_double ();

  125.     // read_longdouble not supported by IDL/Java mapping

  126. 

  127.     /** Reads an IDL string from the input stream.

  128.     * @return  the string read.

  129.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  130.     * If an inconsistency is detected, including not having registered 

  131.     * a streaming policy, then the standard system exception MARSHAL is raised.

  132.     */

  133.     String read_string ();

  134. 

  135.     /** Reads an IDL wide string from the input stream.

  136.     * @return  the wide string read.

  137.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  138.     * If an inconsistency is detected, including not having registered 

  139.     * a streaming policy, then the standard system exception MARSHAL is raised.

  140.     */

  141.     String read_wstring ();

  142. 

  143.     /** Reads an IDL CORBA::Object from the input stream.

  144.     * @return  the CORBA::Object read.

  145.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  146.     * If an inconsistency is detected, including not having registered 

  147.     * a streaming policy, then the standard system exception MARSHAL is raised.

  148.     */

  149.     org.omg.CORBA.Object read_Object ();

  150. 

  151.     /** Reads an IDL Abstract interface from the input stream.

  152.     * @return  the Abstract interface read.

  153.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  154.     * If an inconsistency is detected, including not having registered 

  155.     * a streaming policy, then the standard system exception MARSHAL is raised.

  156.     */

  157.     java.lang.Object read_Abstract ();

  158. 

  159.     /** Reads an IDL value type from the input stream.

  160.     * @return  the value type read.

  161.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  162.     * If an inconsistency is detected, including not having registered 

  163.     * a streaming policy, then the standard system exception MARSHAL is raised.

  164.     */

  165.     java.io.Serializable read_Value ();

  166. 

  167.     /** Reads an IDL typecode from the input stream.

  168.     * @return  the typecode read.

  169.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  170.     * If an inconsistency is detected, including not having registered 

  171.     * a streaming policy, then the standard system exception MARSHAL is raised.

  172.     */

  173.     org.omg.CORBA.TypeCode read_TypeCode ();

  174. 

  175.     /** Reads array of IDL Anys from offset for length elements from the

  176.     * input stream.  

  177.     * @param seq The out parameter holder for the array to be read.

  178.     * @param offset The index into seq of the first element to read from the

  179.     * input stream.

  180.     * @param length The number of elements to read from the input stream.

  181.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  182.     * If an inconsistency is detected, including not having registered 

  183.     * a streaming policy, then the standard system exception MARSHAL is raised.

  184.     */

  185.     void read_any_array (org.omg.CORBA.AnySeqHolder seq, int offset, int length);

  186. 

  187.     /** Reads array of IDL booleans from offset for length elements from the

  188.     * input stream.  

  189.     * @param seq The out parameter holder for the array to be read.

  190.     * @param offset The index into seq of the first element to read from the

  191.     * input stream.

  192.     * @param length The number of elements to read from the input stream.

  193.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  194.     * If an inconsistency is detected, including not having registered 

  195.     * a streaming policy, then the standard system exception MARSHAL is raised.

  196.     */

  197.     void read_boolean_array (org.omg.CORBA.BooleanSeqHolder seq, int offset, int length);

  198. 

  199.     /** Reads array of IDL characters from offset for length elements from the

  200.     * input stream.  

  201.     * @param seq The out parameter holder for the array to be read.

  202.     * @param offset The index into seq of the first element to read from the

  203.     * input stream.

  204.     * @param length The number of elements to read from the input stream.

  205.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  206.     * If an inconsistency is detected, including not having registered 

  207.     * a streaming policy, then the standard system exception MARSHAL is raised.

  208.     */

  209.     void read_char_array (org.omg.CORBA.CharSeqHolder seq, int offset, int length);

  210. 

  211.     /** Reads array of IDL wide characters from offset for length elements from the

  212.     * input stream.  

  213.     * @param seq The out parameter holder for the array to be read.

  214.     * @param offset The index into seq of the first element to read from the

  215.     * input stream.

  216.     * @param length The number of elements to read from the input stream.

  217.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  218.     * If an inconsistency is detected, including not having registered 

  219.     * a streaming policy, then the standard system exception MARSHAL is raised.

  220.     */

  221.     void read_wchar_array (org.omg.CORBA.WCharSeqHolder seq, int offset, int length);

  222. 

  223.     /** Reads array of IDL octets from offset for length elements from the

  224.     * input stream.  

  225.     * @param seq The out parameter holder for the array to be read.

  226.     * @param offset The index into seq of the first element to read from the

  227.     * input stream.

  228.     * @param length The number of elements to read from the input stream.

  229.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  230.     * If an inconsistency is detected, including not having registered 

  231.     * a streaming policy, then the standard system exception MARSHAL is raised.

  232.     */

  233.     void read_octet_array (org.omg.CORBA.OctetSeqHolder seq, int offset, int length);

  234. 

  235.     /** Reads array of IDL shorts from offset for length elements from the

  236.     * input stream.  

  237.     * @param seq The out parameter holder for the array to be read.

  238.     * @param offset The index into seq of the first element to read from the

  239.     * input stream.

  240.     * @param length The number of elements to read from the input stream.

  241.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  242.     * If an inconsistency is detected, including not having registered 

  243.     * a streaming policy, then the standard system exception MARSHAL is raised.

  244.     */

  245.     void read_short_array (org.omg.CORBA.ShortSeqHolder seq, int offset, int length);

  246. 

  247.     /** Reads array of IDL unsigned shorts from offset for length elements from the

  248.     * input stream.  

  249.     * @param seq The out parameter holder for the array to be read.

  250.     * @param offset The index into seq of the first element to read from the

  251.     * input stream.

  252.     * @param length The number of elements to read from the input stream.

  253.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  254.     * If an inconsistency is detected, including not having registered 

  255.     * a streaming policy, then the standard system exception MARSHAL is raised.

  256.     */

  257.     void read_ushort_array (org.omg.CORBA.UShortSeqHolder seq, int offset, int length);

  258. 

  259.     /** Reads array of IDL longs from offset for length elements from the

  260.     * input stream.  

  261.     * @param seq The out parameter holder for the array to be read.

  262.     * @param offset The index into seq of the first element to read from the

  263.     * input stream.

  264.     * @param length The number of elements to read from the input stream.

  265.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  266.     * If an inconsistency is detected, including not having registered 

  267.     * a streaming policy, then the standard system exception MARSHAL is raised.

  268.     */

  269.     void read_long_array (org.omg.CORBA.LongSeqHolder seq, int offset, int length);

  270. 

  271.     /** Reads array of IDL unsigned longs from offset for length elements from the

  272.     * input stream.  

  273.     * @param seq The out parameter holder for the array to be read.

  274.     * @param offset The index into seq of the first element to read from the

  275.     * input stream.

  276.     * @param length The number of elements to read from the input stream.

  277.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  278.     * If an inconsistency is detected, including not having registered 

  279.     * a streaming policy, then the standard system exception MARSHAL is raised.

  280.     */

  281.     void read_ulong_array (org.omg.CORBA.ULongSeqHolder seq, int offset, int length);

  282. 

  283.     /** Reads array of IDL unsigned long longs from offset for length elements from the

  284.     * input stream.  

  285.     * @param seq The out parameter holder for the array to be read.

  286.     * @param offset The index into seq of the first element to read from the

  287.     * input stream.

  288.     * @param length The number of elements to read from the input stream.

  289.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  290.     * If an inconsistency is detected, including not having registered 

  291.     * a streaming policy, then the standard system exception MARSHAL is raised.

  292.     */

  293.     void read_ulonglong_array (org.omg.CORBA.ULongLongSeqHolder seq, int offset, int length);

  294. 

  295.     /** Reads array of IDL long longs from offset for length elements from the

  296.     * input stream.  

  297.     * @param seq The out parameter holder for the array to be read.

  298.     * @param offset The index into seq of the first element to read from the

  299.     * input stream.

  300.     * @param length The number of elements to read from the input stream.

  301.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  302.     * If an inconsistency is detected, including not having registered 

  303.     * a streaming policy, then the standard system exception MARSHAL is raised.

  304.     */

  305.     void read_longlong_array (org.omg.CORBA.LongLongSeqHolder seq, int offset, int length);

  306. 

  307.     /** Reads array of IDL floats from offset for length elements from the

  308.     * input stream.  

  309.     * @param seq The out parameter holder for the array to be read.

  310.     * @param offset The index into seq of the first element to read from the

  311.     * input stream.

  312.     * @param length The number of elements to read from the input stream.

  313.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  314.     * If an inconsistency is detected, including not having registered 

  315.     * a streaming policy, then the standard system exception MARSHAL is raised.

  316.     */

  317.     void read_float_array (org.omg.CORBA.FloatSeqHolder seq, int offset, int length);

  318. 

  319.     /** Reads array of IDL doubles from offset for length elements from the

  320.     * input stream.  

  321.     * @param seq The out parameter holder for the array to be read.

  322.     * @param offset The index into seq of the first element to read from the

  323.     * input stream.

  324.     * @param length The number of elements to read from the input stream.

  325.     * @throws <code>org.omg.CORBA.MARSHAL</code>

  326.     * If an inconsistency is detected, including not having registered 

  327.     * a streaming policy, then the standard system exception MARSHAL is raised.

  328.     */

  329.     void read_double_array (org.omg.CORBA.DoubleSeqHolder seq, int offset, int length);

  330. } // interface DataInputStream

  331.