Package org.opennms.reporting.availability

Class Categories

java.lang.Object

org.opennms.reporting.availability.Categories

All Implemented Interfaces:

Serializable

public class Categories
extends Object
implements Serializable

Class Categories.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Categories()

Method Summary

Modifier and Type	Method	Description
void	addCategory(int index, Category vCategory)
void	addCategory(Category vCategory)
Enumeration<Category>	enumerateCategory()	Method enumerateCategory.
Category[]	getCategory()	Method getCategory.Returns the contents of the collection in an Array.
Category	getCategory(int index)	Method getCategory.
List<Category>	getCategoryCollection()	Method getCategoryCollection.Returns a reference to 'categoryList'.
int	getCategoryCount()	Method getCategoryCount.
Iterator<Category>	iterateCategory()	Method iterateCategory.
void	removeAllCategory()
boolean	removeCategory(Category vCategory)	Method removeCategory.
Category	removeCategoryAt(int index)	Method removeCategoryAt.
void	setCategory(int index, Category vCategory)
void	setCategory(List<Category> vCategoryList)	Sets the value of 'categoryList' by copying the given Vector.
void	setCategory(Category[] vCategoryArray)
void	setCategoryCollection(List<Category> categoryList)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Categories

public Categories()

Method Detail

addCategory

public void addCategory(Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

vCategory -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addCategory

public void addCategory(int index,
                        Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

index -

vCategory -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateCategory

public Enumeration<Category> enumerateCategory()

Method enumerateCategory.

Returns:

an Enumeration over all possible elements of this collection

getCategory

public Category getCategory(int index)
                     throws IndexOutOfBoundsException

Method getCategory.

Parameters:

index -

Returns:

the value of the Category at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getCategory

public Category[] getCategory()

Method getCategory.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getCategoryCollection

public List<Category> getCategoryCollection()

Method getCategoryCollection.Returns a reference to 'categoryList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getCategoryCount

public int getCategoryCount()

Method getCategoryCount.

Returns:

the size of this collection

iterateCategory

public Iterator<Category> iterateCategory()

Method iterateCategory.

Returns:

an Iterator over all possible elements in this collection

removeAllCategory

public void removeAllCategory()

removeCategory

public boolean removeCategory(Category vCategory)

Method removeCategory.

Parameters:

vCategory -

Returns:

true if the object was removed from the collection.

removeCategoryAt

public Category removeCategoryAt(int index)

Method removeCategoryAt.

Parameters:

index -

Returns:

the element removed from the collection

setCategory

public void setCategory(int index,
                        Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

index -

vCategory -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setCategory

public void setCategory(Category[] vCategoryArray)

Parameters:

vCategoryArray -

setCategory

public void setCategory(List<Category> vCategoryList)

Sets the value of 'categoryList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vCategoryList - the Vector to copy.

setCategoryCollection

public void setCategoryCollection(List<Category> categoryList)

Deprecated.

Sets the value of 'categoryList' by setting it to the given Vector. No type checking is performed.

Parameters:

categoryList - the Vector to set.