uka.util
Class CharQueue

java.lang.Object
  extended byuka.util.CharSequence
      extended byuka.util.CharQueue
All Implemented Interfaces:
CharIterator, Printable, java.io.Serializable

public final class CharQueue
extends CharSequence
implements java.io.Serializable, Printable

Queue of values of type char.

Author:
Bernhard Haumacher
See Also:
Serialized Form

Field Summary
private  EnlargingCharArray 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.CharSequence
EMPTY
 
Constructor Summary
CharQueue()
           
 
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.
 char get(int index)
           
 boolean hasNext()
          Indicates whether more char values can be returned by this iterator.
 boolean isEmpty()
          Checks, whether this queue is empty.
 char next()
          Read from this queue via the iterator interface.
 char read()
          Read the next value from this queue.
 int size()
          Returns the number of values that are currently in this queue.
 char top()
          Return the next value from this queue without removing it.
 void write(char value)
          Write the given value into this queue.
 
Methods inherited from class uka.util.CharSequence
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 EnlargingCharArray data
Stores the data of this queue.

See Also:
readPos, writePos
Constructor Detail

CharQueue

public CharQueue()
Method Detail

read

public char read()
Read the next value from this queue.


top

public char top()
Return the next value from this queue without removing it.


get

public char get(int index)

write

public void write(char 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: CharIterator
Indicates whether more char values can be returned by this iterator.

Specified by:
hasNext in interface CharIterator
Returns:
true if more char values can be returned by this iterator; returns false otherwise.
See Also:
next()

next

public char next()
Read from this queue via the iterator interface.

Specified by:
next in interface CharIterator
Returns:
the next char value of this iterator.
See Also:
CharIterator.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)