uka.util
Class ByteQueue

java.lang.Object
  uka.util.ByteSequence
      uka.util.ByteQueue

All Implemented Interfaces:

ByteIterator, Printable, java.io.Serializable

public final class ByteQueue

extends ByteSequence

implements java.io.Serializable, Printable

Queue of values of type byte.

Author:

Bernhard Haumacher

See Also:

Serialized Form

Field Summary

private EnlargingByteArray	data Stores the data of this queue.
static int	MIN_FREE
(package private) int	readPos The next value will be read() from data at index readPos.
(package private) int	writePos The next value will be written into data at index writePos.

Fields inherited from class uka.util.ByteSequence

EMPTY

Constructor Summary

ByteQueue()

Method Summary

void	appendTo(ToString s) This method should append the contents of each instance variable of the current object to the given ToString object.
void	clear() Removes all values from this queue.
byte	get(int index)
boolean	hasNext() Indicates whether more byte values can be returned by this iterator.
boolean	isEmpty() Checks, whether this queue is empty.
byte	next() Read from this queue via the iterator interface.
byte	read() Read the next value from this queue.
int	size() Returns the number of values that are currently in this queue.
byte	top() Return the next value from this queue without removing it.
void	write(byte value) Write the given value into this queue.

Methods inherited from class uka.util.ByteSequence

remove

Methods inherited from class java.lang.Object

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

Field Detail

MIN_FREE

public static final int MIN_FREE

See Also:

Constant Field Values

writePos

int writePos

The next value will be written into data at index writePos.

readPos

int readPos

The next value will be read() from data at index readPos.

data

private final EnlargingByteArray data

Stores the data of this queue.

See Also:

readPos, writePos

Constructor Detail

ByteQueue

public ByteQueue()

Method Detail

read

public byte read()

Read the next value from this queue.

top

public byte top()

Return the next value from this queue without removing it.

get

public byte get(int index)

write

public void write(byte value)

Write the given value into this queue.

isEmpty

public boolean isEmpty()

Checks, whether this queue is empty.

size

public int size()

Returns the number of values that are currently in this queue.

hasNext

public boolean hasNext()

Description copied from interface: ByteIterator

Indicates whether more byte values can be returned by this iterator.

Specified by:

hasNext in interface ByteIterator

Returns:

true if more byte values can be returned by this iterator; returns false otherwise.

See Also:

next()

next

public byte next()

Read from this queue via the iterator interface.

Specified by:

next in interface ByteIterator

Returns:

the next byte value of this iterator.

See Also:

ByteIterator.hasNext()

clear

public void clear()

Removes all values from this queue. For queues of reference values: This method also makes sure that all references to objects inserted into this queue are removed.

appendTo

public void appendTo(ToString s)

Description copied from interface: Printable

This method should append the contents of each instance variable of the current object to the given ToString object. The appended data should be labeled with the name of the corresponding instance variable.

Specified by:

appendTo in interface Printable

See Also:

ToString, ToString.append(String, Object), ToString.append(String, boolean), ToString.append(String, byte), ToString.append(String, int)