1. /*

  2.  * @(#)DataInputStream.java	1.9 03/01/23

  3.  *

  4.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package org.omg.CORBA;

  9. 

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

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

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

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

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

  15. * @version 1.9 01/23/03

  16. */

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

  18. {

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

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

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

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

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

  24.     */

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

  26. 

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

  28.     * @return  the boolean read.

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

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

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

  32.     */

  33.     boolean read_boolean ();

  34. 

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

  36.     * @return  the character read.

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

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

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

  40.     */

  41.     char read_char ();

  42. 

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

  44.     * @return  the wide character read.

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

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

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

  48.     */

  49.     char read_wchar ();

  50. 

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

  52.     * @return  the octet value read.

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

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

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

  56.     */

  57.     byte read_octet ();

  58. 

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

  60.     * @return  the short read.

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

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

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

  64.     */

  65.     short read_short ();

  66. 

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

  68.     * @return  the unsigned short read.

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

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

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

  72.     */

  73.     short read_ushort ();

  74. 

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

  76.     * @return  the long read.

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

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

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

  80.     */

  81.     int read_long ();

  82. 

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

  84.     * @return  the unsigned long read.

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

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

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

  88.     */

  89.     int read_ulong ();

  90. 

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

  92.     * @return  the long long read.

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

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

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

  96.     */

  97.     long read_longlong ();

  98. 

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

  100.     * @return  the unsigned long long read.

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

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

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

  104.     */

  105.     long read_ulonglong ();

  106. 

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

  108.     * @return  the float read.

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

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

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

  112.     */

  113.     float read_float ();

  114. 

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

  116.     * @return  the double read.

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

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

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

  120.     */

  121.     double read_double ();

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

  123. 

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

  125.     * @return  the string read.

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

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

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

  129.     */

  130.     String read_string ();

  131. 

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

  133.     * @return  the wide string read.

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

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

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

  137.     */

  138.     String read_wstring ();

  139. 

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

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

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

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

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

  145.     */

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

  147. 

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

  149.     * @return  the Abstract interface read.

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

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

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

  153.     */

  154.     java.lang.Object read_Abstract ();

  155. 

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

  157.     * @return  the value type read.

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

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

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

  161.     */

  162.     java.io.Serializable read_Value ();

  163. 

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

  165.     * @return  the typecode read.

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

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

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

  169.     */

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

  171. 

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

  173.     * input stream.  

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

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

  176.     * input stream.

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

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

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

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

  181.     */

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

  183. 

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

  185.     * input stream.  

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

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

  188.     * input stream.

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

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

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

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

  193.     */

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

  195. 

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

  197.     * input stream.  

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

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

  200.     * input stream.

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

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

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

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

  205.     */

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

  207. 

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

  209.     * input stream.  

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

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

  212.     * input stream.

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

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

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

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

  217.     */

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

  219. 

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

  221.     * input stream.  

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

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

  224.     * input stream.

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

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

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

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

  229.     */

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

  231. 

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

  233.     * input stream.  

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

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

  236.     * input stream.

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

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

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

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

  241.     */

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

  243. 

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

  245.     * input stream.  

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

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

  248.     * input stream.

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

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

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

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

  253.     */

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

  255. 

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

  257.     * input stream.  

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

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

  260.     * input stream.

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

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

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

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

  265.     */

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

  267. 

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

  269.     * input stream.  

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

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

  272.     * input stream.

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

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

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

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

  277.     */

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

  279. 

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

  281.     * input stream.  

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

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

  284.     * input stream.

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

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

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

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

  289.     */

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

  291. 

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

  293.     * input stream.  

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

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

  296.     * input stream.

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

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

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

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

  301.     */

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

  303. 

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

  305.     * input stream.  

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

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

  308.     * input stream.

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

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

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

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

  313.     */

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

  315. 

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

  317.     * input stream.  

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

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

  320.     * input stream.

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

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

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

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

  325.     */

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

  327. } // interface DataInputStream

  328.