casa

Class ItemBuffer<T>

java.lang.Object

casa.ItemBuffer<T>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

EventQueue

public abstract class ItemBuffer<T>
extends Object
implements Iterable<T>

This is a thin wrapper for java.util.LinkedList.

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private LinkedList<T>	items refers to the actual underlying data structure being used

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ItemBuffer() Constructs an empty ItemBuffer

Method Summary

Modifier and Type	Method and Description
boolean	contains(T item)
protected T	getItem() Returns the first object in the list
protected int	insertPos(T item) Template method to be overridden to change the behaviour of method putItem().
boolean	isEmpty() Returns true iff the buffer is empty
Iterator<T>	iterator() Warning: the returned iterator is NOT synchronized.
protected void	notifyNewItem(T item) This method is called whenever putItem(Object) is called.
protected T	peek()
protected void	putItem(T item) Inserts the item into the buffer at the position specified by the insertPos(item) method.
protected boolean	remove(Object o)
int	size() Returns the number of items in the buffer
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

items

private LinkedList<T> items

refers to the actual underlying data structure being used

Constructor Detail

ItemBuffer

protected ItemBuffer()

Constructs an empty ItemBuffer

Method Detail

getItem

protected T getItem()

Returns the first object in the list

Returns:

first object in the list

remove

protected boolean remove(Object o)

peek

protected T peek()

putItem

protected void putItem(T item)

Inserts the item into the buffer at the position specified by the insertPos(item) method. By default insertPos() returns the size of the buffer, so the default behaviour to append item. Subclasses should override insertPos() to change this behaviour.

Parameters:

item - object to insert into the list

notifyNewItem

protected void notifyNewItem(T item)

This method is called whenever putItem(Object) is called. Subclasses should override to provide the actual behaviour. This method does nothing.

Parameters:

item - the item that was queued

isEmpty

public boolean isEmpty()

Returns true iff the buffer is empty

Returns:

true iff the buffer is empty

insertPos

protected int insertPos(T item)

Template method to be overridden to change the behaviour of method putItem(). This implementation returns the size of the buffer, causing putItem() to append new items to the buffer. You could, for example, always return 0, which would make it behave like a stack.

Parameters:

item - the item to decide where to put in the buffer

Returns:

the size of the buffer.

iterator

public Iterator<T> iterator()

Warning: the returned iterator is NOT synchronized.

Specified by:

iterator in interface Iterable<T>

Returns:

an iterator for the buffer

size

public int size()

Returns the number of items in the buffer

Returns:

the number of items in the buffer

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(T item)