Module org.jboss.marshalling

Package org.jboss.marshalling

Class SimpleDataInput

java.lang.Object

java.io.InputStream

org.jboss.marshalling.SimpleByteInput

org.jboss.marshalling.ByteInputStream

org.jboss.marshalling.SimpleDataInput

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable, ByteInput

Direct Known Subclasses:

AbstractObjectInput

public class SimpleDataInput
extends ByteInputStream
implements DataInput

A simple base implementation of DataInput which wraps a ByteInput. This implementation maintains an internal buffer.

Field Summary

Fields

Modifier and Type	Field	Description
protected final byte[]	buffer	The internal buffer.
protected int	limit	The buffer limit.
protected int	position	The buffer position.
protected long	totalBytesRead	Total number of bytes read and skipped from the beginning.

Fields inherited from class org.jboss.marshalling.ByteInputStream

byteInput

Constructor Summary

Constructors

Constructor	Description
SimpleDataInput(int bufferSize)	Construct a new instance which wraps nothing.
SimpleDataInput(int bufferSize, ByteInput byteInput)	Construct a new instance.
SimpleDataInput(ByteInput byteInput)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
int	available()	Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	close()
protected void	finish()	Finish reading from the current input.
int	read()	Reads the next byte of data from the input stream.
int	read(byte[] b)	Read some bytes from the input stream into the given array.
int	read(byte[] b, int off, int len)	Read some bytes from the input stream into the given array.
boolean	readBoolean()
byte	readByte()
double	readDouble()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
char	readChar()
int	readInt()
protected int	readIntDirect()	Read an int value.
String	readLine()
long	readLong()
protected long	readLongDirect()
short	readShort()
int	readUnsignedByte()
protected int	readUnsignedByteDirect()	Read an unsigned byte directly.
int	readUnsignedShort()
String	readUTF()
long	skip(long n)	Skips over and discards up to n bytes of data from this input stream.
int	skipBytes(int n)
protected void	start(ByteInput byteInput)	Start reading from the given input.

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

buffer

protected final byte[] buffer

The internal buffer.

position

protected int position

The buffer position.

limit

protected int limit

The buffer limit.

totalBytesRead

protected long totalBytesRead

Total number of bytes read and skipped from the beginning.

Constructor Details

SimpleDataInput

public SimpleDataInput(int bufferSize)

Construct a new instance which wraps nothing.

Parameters:

bufferSize - the internal buffer size to use

SimpleDataInput

public SimpleDataInput(int bufferSize,
 ByteInput byteInput)

Construct a new instance.

Parameters:

bufferSize - the internal buffer size to use

byteInput - the byte input to initially wrap

SimpleDataInput

public SimpleDataInput(ByteInput byteInput)

Construct a new instance. A default buffer size is used.

Parameters:

byteInput - the byte input to initially wrap

Method Details

read

public int read()
         throws IOException

Reads the next byte of data from the input stream. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in interface ByteInput

Overrides:

read in class ByteInputStream

Returns:

the next byte, or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

read

public int read(byte[] b)
         throws IOException

Read some bytes from the input stream into the given array. Returns the number of bytes actually read (possibly zero), or -1 if the end of stream has been reached.

Specified by:

read in interface ByteInput

Overrides:

read in class ByteInputStream

Parameters:

b - the destination array

Returns:

the number of bytes read (possibly zero), or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Read some bytes from the input stream into the given array. Returns the number of bytes actually read (possibly zero), or -1 if the end of stream has been reached.

Specified by:

read in interface ByteInput

Overrides:

read in class ByteInputStream

Parameters:

b - the destination array

off - the offset into the array into which data should be read

len - the number of bytes to attempt to fill in the destination array

Returns:

the number of bytes read (possibly zero), or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

skip

public long skip(long n)
          throws IOException

Skips over and discards up to n bytes of data from this input stream. If the end of stream is reached, this method returns 0 in order to be consistent with InputStream.skip(long).

Specified by:

skip in interface ByteInput

Overrides:

skip in class ByteInputStream

Parameters:

n - the number of bytes to attempt to skip

Returns:

the number of bytes skipped

Throws:

IOException - if an error occurs

available

public int available()
              throws IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

Specified by:

available in interface ByteInput

Overrides:

available in class ByteInputStream

Returns:

the number of bytes

Throws:

IOException - if an error occurs

readFully

public void readFully(byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] b,
 int off,
 int len)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Specified by:

skipBytes in interface DataInput

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readUnsignedByteDirect

protected int readUnsignedByteDirect()
                              throws IOException

Read an unsigned byte directly.

Returns:

the unsigned byte

Throws:

IOException - if an error occurs

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readLongDirect

protected long readLongDirect()
                       throws IOException

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readIntDirect

protected int readIntDirect()
                     throws IOException

Read an int value.

Returns:

the value

Throws:

IOException - if an error occurs

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ByteInputStream

Throws:

IOException

start

protected void start(ByteInput byteInput)
              throws IOException

Start reading from the given input. The internal buffer is discarded.

Parameters:

byteInput - the new input from which to read

Throws:

IOException - not thrown by this implementation, but may be overridden to be thrown if a problem occurs

finish

protected void finish()
               throws IOException

Finish reading from the current input. The internal buffer is discarded, not flushed.

Throws:

IOException - not thrown by this implementation, but may be overridden to be thrown if a problem occurs