com.softwareag.um.modules.io.PrimitiveTypeInputStream Class Reference

This class implements DataInput functions. More...

Inherits DataInput.

Public Member Functions

int available () throws IOException
 Returns the number of bytes available in the underlying Streams. More...
 
void close () throws IOException
 Closes the underlying stream and makes it unavailable for any further functions. More...
 
 PrimitiveTypeInputStream (InputStream is) throws IOException
 Creates an instance of the class using the supplied InputStream. More...
 
boolean readBoolean () throws IOException
 Reads one input byte and returns true if that byte is nonzero, false if that byte is zero. More...
 
byte readByte () throws IOException
 Reads and returns one input byte. More...
 
char readChar () throws IOException
 Reads two input bytes and returns a char value. More...
 
double readDouble () throws IOException
 Reads eight input bytes and returns a double value. More...
 
float readFloat () throws IOException
 Reads four input bytes and returns a float value. More...
 
void readFully (byte[] buffer) throws IOException
 Reads some bytes from an input stream and stores them into the buffer array b. More...
 
void readFully (byte[] buffer, int offset, int length) throws IOException
 Reads len bytes from an input stream. More...
 
int readInt () throws IOException
 Reads four input bytes and returns an int value. More...
 
String readLine () throws IOException
 This is not supported. More...
 
long readLong () throws IOException
 Reads eight input bytes and returns a long value. More...
 
short readShort () throws IOException
 Reads two input bytes and returns a short value. More...
 
int readUnsignedByte () throws IOException
 Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. More...
 
int readUnsignedShort () throws IOException
 Reads two input bytes and returns an int value in the range 0 through 65535. More...
 
String readUTF () throws IOException
 Reads a UTF-8 encoded string from the input stream. More...
 
int skipBytes (int skip) throws IOException
 Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes. More...
 

Detailed Description

This class implements DataInput functions.

See Also
java.io.DataInput

Constructor & Destructor Documentation

com.softwareag.um.modules.io.PrimitiveTypeInputStream.PrimitiveTypeInputStream ( InputStream  is) throws IOException

Creates an instance of the class using the supplied InputStream.

Exceptions
IOExceptionif unable to construct the object due to the Input Stream being closed

Member Function Documentation

int com.softwareag.um.modules.io.PrimitiveTypeInputStream.available ( ) throws IOException

Returns the number of bytes available in the underlying Streams.

Returns
Number of bytes
void com.softwareag.um.modules.io.PrimitiveTypeInputStream.close ( ) throws IOException

Closes the underlying stream and makes it unavailable for any further functions.

Exceptions
IOExceptionif the stream is already closed
boolean com.softwareag.um.modules.io.PrimitiveTypeInputStream.readBoolean ( ) throws IOException

Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.

This method is suitable for reading the byte written by the writeBoolean method of interface DataOutput.

Returns
the boolean value read.
Exceptions
IOExceptionif an I/O error occurs.
byte com.softwareag.um.modules.io.PrimitiveTypeInputStream.readByte ( ) throws IOException

Reads and returns one input byte.

The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput.

Returns
the 8-bit value read.
Exceptions
IOExceptionif an I/O error occurs.
char com.softwareag.um.modules.io.PrimitiveTypeInputStream.readChar ( ) throws IOException

Reads two input bytes and returns a char value.

Let a be the first byte read and b be the second byte. The value returned is:

(char)((a << 8) | (b & 0xff))

This method is suitable for reading bytes written by the writeChar method of interface DataOutput.

Returns
the char value read.
Exceptions
IOExceptionif an I/O error occurs.
double com.softwareag.um.modules.io.PrimitiveTypeInputStream.readDouble ( ) throws IOException

Reads eight input bytes and returns a double value.

It does this by first constructing a long value in exactly the manner of the readlong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput.

Returns
the double value read.
Exceptions
IOExceptionif an I/O error occurs.
float com.softwareag.um.modules.io.PrimitiveTypeInputStream.readFloat ( ) throws IOException

Reads four input bytes and returns a float value.

It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput.

Returns
the float value read.
Exceptions
IOExceptionif an I/O error occurs.
void com.softwareag.um.modules.io.PrimitiveTypeInputStream.readFully ( byte[]  buffer) throws IOException

Reads some bytes from an input stream and stores them into the buffer array b.

The number of bytes read is equal to the length of b.

This method blocks until one of the following conditions occurs:

  • b.length bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[0], the next one into b[1], and so on. If an exception is thrown from this method, then it may be that some but not all bytes of b have been updated with data from the input stream.

Parameters
bufferthe buffer into which the data is read.
Exceptions
IOExceptionif an I/O error occurs.
void com.softwareag.um.modules.io.PrimitiveTypeInputStream.readFully ( byte[]  buffer,
int  offset,
int  length 
) throws IOException

Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

  • len bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.

Parameters
bufferthe buffer into which the data is read.
offsetan int specifying the offset into the data.
lengthan int specifying the number of bytes to read.
Exceptions
IOExceptionif an I/O error occurs.
int com.softwareag.um.modules.io.PrimitiveTypeInputStream.readInt ( ) throws IOException

Reads four input bytes and returns an int value.

Let a-d be the first through fourth bytes read. The value returned is:


(((a & 0xff) << 24) | ((b & 0xff) << 16) |
&#32;((c & 0xff) << 8) | (d & 0xff))

This method is suitable for reading bytes written by the writeInt method of interface DataOutput.

Returns
the int value read.
Exceptions
IOExceptionif an I/O error occurs.
String com.softwareag.um.modules.io.PrimitiveTypeInputStream.readLine ( ) throws IOException

This is not supported.

Returns
null
long com.softwareag.um.modules.io.PrimitiveTypeInputStream.readLong ( ) throws IOException

Reads eight input bytes and returns a long value.

Let a-h be the first through eighth bytes read. The value returned is:

 
(((long)(a & 0xff) << 56) |
 ((long)(b & 0xff) << 48) |
 ((long)(c & 0xff) << 40) |
 ((long)(d & 0xff) << 32) |
 ((long)(e & 0xff) << 24) |
 ((long)(f & 0xff) << 16) |
 ((long)(g & 0xff) <<  8) |
 ((long)(h & 0xff)))

This method is suitable for reading bytes written by the writeLong method of interface DataOutput.

Returns
the long value read.
Exceptions
IOExceptionif an I/O error occurs.
short com.softwareag.um.modules.io.PrimitiveTypeInputStream.readShort ( ) throws IOException

Reads two input bytes and returns a short value.

Let a be the first byte read and b be the second byte. The value returned is:

(short)((a << 8) | (b & 0xff))

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput.

Returns
the 16-bit value read.
Exceptions
IOExceptionif an I/O error occurs.
int com.softwareag.um.modules.io.PrimitiveTypeInputStream.readUnsignedByte ( ) throws IOException

Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.

This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255.

Returns
the unsigned 8-bit value read.
Exceptions
IOExceptionif an I/O error occurs.
int com.softwareag.um.modules.io.PrimitiveTypeInputStream.readUnsignedShort ( ) throws IOException

Reads two input bytes and returns an int value in the range 0 through 65535.

Let a be the first byte read and b be the second byte. The value returned is:

(((a & 0xff) << 8) | (b & 0xff))

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535.

Returns
the unsigned 16-bit value read.
Exceptions
IOExceptionif an I/O error occurs.
String com.softwareag.um.modules.io.PrimitiveTypeInputStream.readUTF ( ) throws IOException

Reads a UTF-8 encoded string from the input stream.

The string must have been written using the writeUTF() method

Returns
String decoded from the stream
Exceptions
IOExceptionif I/O error has occurred
int com.softwareag.um.modules.io.PrimitiveTypeInputStream.skipBytes ( int  skip) throws IOException

Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes.

However, it may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. This method never throws an EOFException. The actual number of bytes skipped is returned.

Parameters
skipthe number of bytes to be skipped.
Returns
the number of bytes actually skipped.
Exceptions
IOExceptionif an I/O error occurs.