ifs.fnd.buffer

Class StandardBuffer

java.lang.Object

ifs.fnd.buffer.StandardBuffer

All Implemented Interfaces:

Buffer, java.io.Serializable, java.lang.Cloneable

public class StandardBuffer
extends java.lang.Object
implements Buffer

Single-thread implementation of Buffer interface.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected boolean	frozen
protected java.lang.String	header
protected Item[]	items

Constructor Summary

Constructors

Constructor and Description
StandardBuffer() Constructs a new instance of StandardBuffer.

Method Summary

Modifier and Type	Method and Description
int	addItem(Item item) Append a specified Item to the end of the item list in this Buffer, which may lead to duplicate item names.
int	addItem(java.lang.String itemName, Buffer value) Create and append a new Item to this buffer.
int	addItem(java.lang.String itemName, int value) Create and append a new Item to this buffer.
int	addItem(java.lang.String itemName, java.lang.Object value) Create and append a new Item to the end of the item list in this Buffer, which may lead to duplicate item names.
int	addItem(java.lang.String itemName, java.lang.String value) Create and append a new Item to this buffer.
void	checkItem(Item item) Check if the Item is of Expected class.
void	clear() Clear the contents of this buffer.
java.lang.Object	clone() Clone this Buffer.
int	countItems() Return the number of items collected in this Buffer.
int	countItems(java.lang.String name) Return the number of items with the specified name collected in this Buffer.
boolean	equals(java.lang.Object obj) Compares this buffer to another one.
Item	findItem(java.lang.String itemName) Find a named Item inthis Buffer.
void	freeze() Freezes this buffer.
Buffer	getBuffer(int position) Get the value of the item at the specified position.
Buffer	getBuffer(java.lang.String itemName) Get the value of the item with the specified name.
Buffer	getBuffer(java.lang.String itemName, Buffer defaultValue) Get the value of the item with the specified name.
java.lang.String	getHeader() Return the header of this Buffer.
int	getInt(int position) Get the value of the item at the specified position.
int	getInt(java.lang.String itemName) Get the value of the item with the specified name.
int	getInt(java.lang.String itemName, int defaultValue) Get the value of the item with the specified name.
Item	getItem(int position) Return the Item at the specified position, or null if the position is invalid.
Item	getItem(java.lang.String itemName) Get the item with the specified name.
Item	getItem(java.lang.String itemName, Item defaultValue) Get the item with the specified name.
int	getItemPosition(java.lang.String itemName) Return the position of the first occurrence of a named Item or -1 if such Item does not exist.
java.lang.Object	getObject(int position) Get the value of the item at the specified position.
java.lang.Object	getObject(java.lang.String itemName) Get the value of the item with the specified name.
java.lang.Object	getObject(java.lang.String itemName, java.lang.Object defaultValue) Get the value of the item with the specified name.
java.lang.String	getString(int position) Get the value of the item at the specified position.
java.lang.String	getString(java.lang.String itemName) Get the value of the item with the specified name.
java.lang.String	getString(java.lang.String itemName, java.lang.String defaultValue) Get the value of the item with the specified name.
int	hashCode() Compute the hash code for this Buffer
int	insertItem(Item item, int position) Insert a specified Item at the specified position (0,1,...) in the item list.
boolean	isFrozen() Indicates if this buffer is frozen.
BufferIterator	iterator() Return an iterator over all items in this Buffer.
Buffer	newInstance() Return a new (empty) instance of the same class as this Buffer
Item	newItem() Return a new instance of Item
void	removeItem(int position) Remove the Item at a specified position (0,1,...) in this Buffer.
void	removeItem(java.lang.String itemName) Remove the named item from the item list in this Buffer.
void	removeItems() Remove all items from this Buffer.
void	setHeader(java.lang.String header) Set the header of this Buffer.
int	setItem(java.lang.String itemName, int value) Mofify the first occurence of a named item, or create a new item, if such item does not exist.
int	setItem(java.lang.String itemName, java.lang.String value) Mofify the first occurence of a named item, or create a new item, if such item does not exist.
java.lang.String	toString() Returns a string describing this buffer.
void	unfreeze() Un-freezes this buffer.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

header

protected java.lang.String header

count

protected int count

items

protected Item[] items

frozen

protected boolean frozen

Constructor Detail

StandardBuffer

public StandardBuffer()

Constructs a new instance of StandardBuffer.

Method Detail

clear

public void clear()

Description copied from interface: Buffer

Clear the contents of this buffer. The methods removes all items from the buffer, and also clears other instance variables, like for example header.

Specified by:

clear in interface Buffer

setHeader

public void setHeader(java.lang.String header)

Set the header of this Buffer.

Specified by:

setHeader in interface Buffer

Parameters:

header - string describing the contents of this buffer

getHeader

public java.lang.String getHeader()

Return the header of this Buffer.

Specified by:

getHeader in interface Buffer

Returns:

a string describing the contents of this buffer

countItems

public int countItems()

Return the number of items collected in this Buffer.

Specified by:

countItems in interface Buffer

Returns:

the number of items collected in this Buffer.

countItems

public int countItems(java.lang.String name)

Return the number of items with the specified name collected in this Buffer.

Specified by:

countItems in interface Buffer

Parameters:

name - item name

Returns:

the number of items with the specified name collected in this Buffer.

iterator

public BufferIterator iterator()

Return an iterator over all items in this Buffer.

Specified by:

iterator in interface Buffer

Returns:

an instance of BufferIterator

addItem

public int addItem(Item item)

Append a specified Item to the end of the item list in this Buffer, which may lead to duplicate item names. Return the position of the newly created item (0,1...).

Specified by:

addItem in interface Buffer

Parameters:

item - an item to add to this buffer

Returns:

the zero-based index of the added item.

addItem

public int addItem(java.lang.String itemName,
                   java.lang.Object value)

Create and append a new Item to the end of the item list in this Buffer, which may lead to duplicate item names. Return the position of the newly created item (0,1...).

Specified by:

addItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the position of the newly created item (0,1, ...).

addItem

public int addItem(java.lang.String itemName,
                   Buffer value)

Description copied from interface: Buffer

Create and append a new Item to this buffer. The item will be placed at the end of the item list in this Buffer, which may lead to duplicate item names.

Specified by:

addItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the position of the newly created item (0,1, ...).

addItem

public int addItem(java.lang.String itemName,
                   java.lang.String value)

Description copied from interface: Buffer

Create and append a new Item to this buffer. The item will be placed at the end of the item list in this Buffer, which may lead to duplicate item names.

Specified by:

addItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the position of the newly created item (0,1, ...).

addItem

public int addItem(java.lang.String itemName,
                   int value)

Description copied from interface: Buffer

Create and append a new Item to this buffer. The item will be placed at the end of the item list in this Buffer, which may lead to duplicate item names.

Specified by:

addItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the position of the newly created item (0,1, ...).

insertItem

public int insertItem(Item item,
                      int position)

Insert a specified Item at the specified position (0,1,...) in the item list. This may lead to duplicate item names. Return the position of the inserted item.

Specified by:

insertItem in interface Buffer

Parameters:

item - the item to insert

position - a zero-bassed index

Returns:

the position of the inserted item.

setItem

public int setItem(java.lang.String itemName,
                   java.lang.String value)

Mofify the first occurence of a named item, or create a new item, if such item does not exist. Return the item's position in the buffer (0,1...).

Specified by:

setItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the item's position in the buffer (0,1, ...).

setItem

public int setItem(java.lang.String itemName,
                   int value)

Description copied from interface: Buffer

Mofify the first occurence of a named item, or create a new item, if such item does not exist.

Specified by:

setItem in interface Buffer

Parameters:

itemName - item name

value - item value

Returns:

the item's position in the buffer (0,1, ...).

getItemPosition

public int getItemPosition(java.lang.String itemName)

Return the position of the first occurrence of a named Item or -1 if such Item does not exist.

Specified by:

getItemPosition in interface Buffer

Parameters:

itemName - item name

Returns:

the item position or -1 if such item does not exist.

getItem

public Item getItem(int position)

Return the Item at the specified position, or null if the position is invalid.

Specified by:

getItem in interface Buffer

Parameters:

position - a zero-based index of an existing item in the buffer

Returns:

the item at given index

getItem

public Item getItem(java.lang.String itemName)
             throws ItemNotFoundException

Description copied from interface: Buffer

Get the item with the specified name.

Specified by:

getItem in interface Buffer

Parameters:

itemName - item name

Returns:

the found item

Throws:

ItemNotFoundException - if the specified item does not exist

getItem

public Item getItem(java.lang.String itemName,
                    Item defaultValue)

Description copied from interface: Buffer

Get the item with the specified name.

Specified by:

getItem in interface Buffer

Parameters:

itemName - item name

defaultValue - the default value (possibly null)

Returns:

the named item, or the default value if the named item does not exist

getString

public java.lang.String getString(int position)

Description copied from interface: Buffer

Get the value of the item at the specified position.

Specified by:

getString in interface Buffer

Parameters:

position - an index to an existing item in the buffer

Returns:

the String value of the item at given index

getString

public java.lang.String getString(java.lang.String itemName)
                           throws ItemNotFoundException

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getString in interface Buffer

Parameters:

itemName - item name

Returns:

the String value of the named item

Throws:

ItemNotFoundException - if the specified item does not exist

getString

public java.lang.String getString(java.lang.String itemName,
                                  java.lang.String defaultValue)

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getString in interface Buffer

Parameters:

itemName - item name

defaultValue - the default value (possibly null)

Returns:

the String value of the named item, or the default value if the named item does not exist

getInt

public int getInt(int position)

Description copied from interface: Buffer

Get the value of the item at the specified position.

Specified by:

getInt in interface Buffer

Parameters:

position - an index to an existing item in the buffer

Returns:

the integer value of the item at given index

getInt

public int getInt(java.lang.String itemName)
           throws ItemNotFoundException

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getInt in interface Buffer

Parameters:

itemName - item name

Returns:

the integer value of the named item

Throws:

ItemNotFoundException - if the specified item does not exist

getInt

public int getInt(java.lang.String itemName,
                  int defaultValue)

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getInt in interface Buffer

Parameters:

itemName - item name

defaultValue - the default value

Returns:

the integer value of the named item, or the default value if the named item does not exist

getObject

public java.lang.Object getObject(int position)

Description copied from interface: Buffer

Get the value of the item at the specified position.

Specified by:

getObject in interface Buffer

Parameters:

position - an index of an existing item in the buffer

Returns:

the Object being the value of the item at given index

getObject

public java.lang.Object getObject(java.lang.String itemName)
                           throws ItemNotFoundException

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getObject in interface Buffer

Parameters:

itemName - item name

Returns:

the Object being the value of the named item

Throws:

ItemNotFoundException - if the specified item does not exist

getObject

public java.lang.Object getObject(java.lang.String itemName,
                                  java.lang.Object defaultValue)

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getObject in interface Buffer

Parameters:

itemName - item name

defaultValue - the default value (possibly null)

Returns:

the Object being the value of the named item, or the default value if the named item does not exist

getBuffer

public Buffer getBuffer(int position)

Description copied from interface: Buffer

Get the value of the item at the specified position.

Specified by:

getBuffer in interface Buffer

Parameters:

position - an index to an existing item in the buffer

Returns:

the Buffer being the value of the item at given index

getBuffer

public Buffer getBuffer(java.lang.String itemName)
                 throws ItemNotFoundException

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getBuffer in interface Buffer

Parameters:

itemName - item name

Returns:

the Buffer being the value of the named item

Throws:

ItemNotFoundException - if the specified item does not exist

getBuffer

public Buffer getBuffer(java.lang.String itemName,
                        Buffer defaultValue)

Description copied from interface: Buffer

Get the value of the item with the specified name.

Specified by:

getBuffer in interface Buffer

Parameters:

itemName - item name

defaultValue - the default value (possibly null)

Returns:

the Buffer being the value of the named item, or the default value if the named item does not exist

removeItem

public void removeItem(java.lang.String itemName)

Remove the named item from the item list in this Buffer. This aplies only to the first occurence, if there are many items with the specified name.

Specified by:

removeItem in interface Buffer

Parameters:

itemName - the name of an item

removeItem

public void removeItem(int position)

Remove the Item at a specified position (0,1,...) in this Buffer.

Specified by:

removeItem in interface Buffer

Parameters:

position - zero-based index of an existing item

removeItems

public void removeItems()

Remove all items from this Buffer.

Specified by:

removeItems in interface Buffer

findItem

public Item findItem(java.lang.String itemName)

Description copied from interface: Buffer

Find a named Item inthis Buffer. The name can contain "/"-operator, for example "A/B/C" points to item "C" in sub-buffer "B" of sub-buffer "A" of this buffer.

Specified by:

findItem in interface Buffer

Parameters:

itemName - item name

Returns:

the found Item, or null if such Item does not exist.

newInstance

public Buffer newInstance()

Description copied from interface: Buffer

Return a new (empty) instance of the same class as this Buffer

Specified by:

newInstance in interface Buffer

Returns:

a new, empty instance of Buffer interface

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Buffer

Compares this buffer to another one.

Specified by:

equals in interface Buffer

Overrides:

equals in class java.lang.Object

Returns:

true if a specified Object is a Buffer and has exactly the same contents as this Buffer

clone

public java.lang.Object clone()

Description copied from interface: Buffer

Clone this Buffer.

Specified by:

clone in interface Buffer

Overrides:

clone in class java.lang.Object

Returns:

a new instance of Buffer with the same contents as this buffer.

toString

public java.lang.String toString()

Returns a string describing this buffer. The method is used for debugging purposes. It contains the class name, the buffer header, the hash code and the number of contained items.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: Buffer

Compute the hash code for this Buffer

Specified by:

hashCode in interface Buffer

Overrides:

hashCode in class java.lang.Object

Returns:

an int value representing the contents of this buffer

newItem

public Item newItem()

Description copied from interface: Buffer

Return a new instance of Item

Specified by:

newItem in interface Buffer

Returns:

a new instance of Item

checkItem

public void checkItem(Item item)

Check if the Item is of Expected class. Used for extended implementation.

isFrozen

public boolean isFrozen()

Indicates if this buffer is frozen. Note that this implementation ignores this flag when modifying the buffer contents.

Specified by:

isFrozen in interface Buffer

Returns:

true if this buffer is frozen, false otherwise

freeze

public void freeze()

Description copied from interface: Buffer

Freezes this buffer.

Specified by:

freeze in interface Buffer

unfreeze

public void unfreeze()

Description copied from interface: Buffer

Un-freezes this buffer.

Specified by:

unfreeze in interface Buffer