com.pcube.apps.engage.common
Class BWControllerArray

java.lang.Object
  com.pcube.apps.engage.common.BWControllerArray

All Implemented Interfaces:

Formattable, Serializable, Cloneable

public class BWControllerArray
extends Object
implements Serializable, Cloneable, Formattable

The array of bandwidth controlers. Bandwidth controllers in the array can be modified so that the bandwidth accumulated by them will also be acumulated in the total bandwidth controller.

See Also:

BWController, DeprecatedPackageData, Serialized Form

Field Summary

static int	DEFAULT_DOWNSTREAM_BWC_IDX default up stream and down stream BWC index *
static String	DEFAULT_DOWNSTREAM_BWC_NAME
static int	DEFAULT_UPSTREAM_BWC_IDX
static String	DEFAULT_UPSTREAM_BWC_NAME

Constructor Summary

BWControllerArray()
BWControllerArray Constructor.

Method Summary

int	addNewBWController() Adds an aggregated BWController.
BWController	addNewBWController(int index) Adds an aggregated BWController in a specific index in the BWController array.
Object	clone() Producing an identical object to this object.
boolean	contains(BWController item) Checks if a certain BWController exists in this list.
boolean	contains(String bwcName) Checks if an BWController with bears the specific name exists in this list.
BWController	findByName(String name) find the BWC that has the specified name.
void	fromStream(BufferedReader in, Formatter f) Method fromStream
BWController	getAt(int index) Gets the BWController this list has in a specific index.
int	getIndexOfItem(String name) Gets the index of the BWController in this list which has the specific name.
int	getSize() Gets the size of this list.
com.pcube.apps.engage.foundations.VetoableCollectionChangeListener	getVetoChangeListener()
boolean	isBWCAdded(int bwcIndex) Checks if the BWController in a specific index in the BWController array was added.
Iterator	iterator()
Iterator	iterator(int direction)
ListIterator	listIterator()
ListIterator	listIterator(int direction)
void	remove(int index) Removes the BWController from a specific index in this list.
void	setValueFrom(BWControllerArray other) Method setValueFrom
void	setVetoChangeListener(com.pcube.apps.engage.foundations.VetoableCollectionChangeListener vetoChangeListener) Only a single listener is currently supported.
void	toStream(PrintStream out, Formatter f) Method toStream

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOWNSTREAM_BWC_IDX

public static final int DEFAULT_DOWNSTREAM_BWC_IDX

default up stream and down stream BWC index *

See Also:

Constant Field Values

DEFAULT_UPSTREAM_BWC_IDX

public static final int DEFAULT_UPSTREAM_BWC_IDX

See Also:

Constant Field Values

DEFAULT_DOWNSTREAM_BWC_NAME

public static final String DEFAULT_DOWNSTREAM_BWC_NAME

See Also:

Constant Field Values

DEFAULT_UPSTREAM_BWC_NAME

public static final String DEFAULT_UPSTREAM_BWC_NAME

See Also:

Constant Field Values

Constructor Detail

BWControllerArray

public BWControllerArray()

BWControllerArray Constructor.

Method Detail

clone

public Object clone()

Producing an identical object to this object.

Overrides:

clone in class Object

Returns:

a newly alocated object similar to this object.

contains

public boolean contains(BWController item)

Checks if a certain BWController exists in this list.

Parameters:

item - the queried BWController

Returns:

true if exists, false otherwise

contains

public boolean contains(String bwcName)

Checks if an BWController with bears the specific name exists in this list.

Parameters:

bwcName - the desired BWController's name

Returns:

true if exists, false otherwise

fromStream

public void fromStream(BufferedReader in,
                       Formatter f)
                throws ImportExportException

Description copied from interface: Formattable

Method fromStream

Specified by:

fromStream in interface Formattable

Throws:

ImportExportException

See Also:

Formattable.fromStream(java.io.BufferedReader, com.pcube.apps.engage.common.Formatter)

getAt

public BWController getAt(int index)
                   throws ItemNotFoundException

Gets the BWController this list has in a specific index.

Parameters:

index - - the index of the desired BWController

Returns:

the BWController at the specified location or null if the location is empty

Throws:

ItemNotFoundException

getIndexOfItem

public int getIndexOfItem(String name)

Gets the index of the BWController in this list which has the specific name.

Parameters:

item - the desired BWController's name

Returns:

the BWController's index if exists, -1 otherwise

findByName

public BWController findByName(String name)

find the BWC that has the specified name. if no BWC is found returns null

Parameters:

name -

Returns:

getSize

public int getSize()

Gets the size of this list.

Returns:

this list's size

setValueFrom

public void setValueFrom(BWControllerArray other)
                  throws PropertyVetoException

Method setValueFrom

Parameters:

other -

Throws:

PropertyVetoException

toStream

public void toStream(PrintStream out,
                     Formatter f)

Description copied from interface: Formattable

Method toStream

Specified by:

toStream in interface Formattable

See Also:

Formattable.toStream(java.io.PrintStream, com.pcube.apps.engage.common.Formatter)

addNewBWController

public int addNewBWController()
                       throws com.pcube.apps.engage.foundations.CollectionVetoException

Adds an aggregated BWController.

Returns:

the added BWController index in the BWController array

Throws:

ItemNotFoundException - if there are no BWControllers left to add

com.pcube.apps.engage.foundations.CollectionVetoException

addNewBWController

public BWController addNewBWController(int index)
                                throws com.pcube.apps.engage.foundations.CollectionVetoException

Adds an aggregated BWController in a specific index in the BWController array.

Parameters:

index - the added BWController index in the BWController array

Returns:

the newly created bwc

Throws:

ItemNotFoundException - if the index is out of bound

IllegalArgumentException - if the BWController in the index was already added

com.pcube.apps.engage.foundations.CollectionVetoException

remove

public void remove(int index)
            throws com.pcube.apps.engage.foundations.CollectionVetoException

Removes the BWController from a specific index in this list.

Parameters:

index - the removed BWController's index in this list

Throws:

ItemNotFoundException - if this list has no BWController with the desired values

com.pcube.apps.engage.foundations.CollectionVetoException

isBWCAdded

public boolean isBWCAdded(int bwcIndex)

Checks if the BWController in a specific index in the BWController array was added.

Parameters:

bwcIndex - index of the BWController to check

Returns:

true if added, false otherwise

Throws:

ItemNotFoundException - if the index is out of bound

iterator

public Iterator iterator()

iterator

public Iterator iterator(int direction)

listIterator

public ListIterator listIterator(int direction)

Parameters:

direction -

Returns:

an iterator that returns only the BWControllers with the specified direction

listIterator

public ListIterator listIterator()

Returns:

an instance of a ListIterator

getVetoChangeListener

public com.pcube.apps.engage.foundations.VetoableCollectionChangeListener getVetoChangeListener()

Returns:

Returns the vetoChangeListener.

setVetoChangeListener

public void setVetoChangeListener(com.pcube.apps.engage.foundations.VetoableCollectionChangeListener vetoChangeListener)

Only a single listener is currently supported. To stop listening to events set the listner to null.

Parameters:

vetoChangeListener - The vetoChangeListener to set.