org.eclipse.californium.elements.util

Class DatagramReader

java.lang.Object

org.eclipse.californium.elements.util.DatagramReader

public final class DatagramReader
extends Object

This class describes the functionality to read raw network-ordered datagrams on bit-level.

Constructor Summary

Constructors

Constructor and Description
DatagramReader(byte[] byteArray) Creates a new reader for an array of bytes.
DatagramReader(ByteArrayInputStream byteStream) Creates a new reader for an bytes stream.

Method Summary

Methods

Modifier and Type	Method and Description
int	bitsLeft() Gets the number of remaining bits that can be read from the datagram.
boolean	bytesAvailable() Checks if there are any more bytes available on the stream.
boolean	bytesAvailable(int expectedBytes) Checks whether a given number of bytes can be read.
void	mark() Mark current position to be reseted afterwards.
int	read(int numBits) Reads a sequence of bits from the stream.
byte[]	readBytes(int count) Reads a sequence of bytes from the stream.
byte[]	readBytesLeft() Reads the complete sequence of bytes left in the stream.
long	readLong(int numBits) Reads a sequence of bits from the stream.
byte	readNextByte() Reads the next byte from the stream.
void	reset() Reset reader to last mark.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatagramReader

public DatagramReader(byte[] byteArray)

Creates a new reader for an array of bytes.

Parameters:

byteArray - The byte array to read from.

DatagramReader

public DatagramReader(ByteArrayInputStream byteStream)

Creates a new reader for an bytes stream.

Parameters:

byteStream - The byte stream to read from.

Throws:

NullPointerException - if byte stream is null

Method Detail

mark

public void mark()

Mark current position to be reseted afterwards.

See Also:

reset()

reset

public void reset()

Reset reader to last mark.

See Also:

mark()

readLong

public long readLong(int numBits)

Reads a sequence of bits from the stream.

Parameters:

numBits - The number of bits to read.

Returns:

A Long containing the bits read.

read

public int read(int numBits)

Reads a sequence of bits from the stream.

Parameters:

numBits - The number of bits to read.

Returns:

An integer containing the bits read.

readBytes

public byte[] readBytes(int count)

Reads a sequence of bytes from the stream.

Parameters:

count - The number of bytes to read.

Returns:

The sequence of bytes read from the stream.

readNextByte

public byte readNextByte()

Reads the next byte from the stream.

Returns:

The next byte.

readBytesLeft

public byte[] readBytesLeft()

Reads the complete sequence of bytes left in the stream.

Returns:

The sequence of bytes left in the stream.

bytesAvailable

public boolean bytesAvailable()

Checks if there are any more bytes available on the stream.

Returns:

true if there are bytes left to read, false otherwise.

bytesAvailable

public boolean bytesAvailable(int expectedBytes)

Checks whether a given number of bytes can be read.

Parameters:

expectedBytes - the number of bytes.

Returns:

true if the remaining number of bytes in the buffer is at least expectedBytes.

bitsLeft

public int bitsLeft()

Gets the number of remaining bits that can be read from the datagram.

Returns:

the number of bits