org.opennms.netmgt.config.categories
Class Catinfo

java.lang.Object
  org.opennms.netmgt.config.categories.Catinfo

All Implemented Interfaces:

Serializable

public class Catinfo
extends Object
implements Serializable

Top-level element for the categories.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Catinfo()

Method Summary

void	addCategorygroup(Categorygroup vCategorygroup)
void	addCategorygroup(int index, Categorygroup vCategorygroup)
Enumeration<Categorygroup>	enumerateCategorygroup() Method enumerateCategorygroup.
Categorygroup[]	getCategorygroup() Method getCategorygroup.Returns the contents of the collection in an Array.
Categorygroup	getCategorygroup(int index) Method getCategorygroup.
List<Categorygroup>	getCategorygroupCollection() Method getCategorygroupCollection.Returns a reference to '_categorygroupList'.
int	getCategorygroupCount() Method getCategorygroupCount.
Header	getHeader() Returns the value of field 'header'.
boolean	isValid() Method isValid.
Iterator<Categorygroup>	iterateCategorygroup() Method iterateCategorygroup.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllCategorygroup()
boolean	removeCategorygroup(Categorygroup vCategorygroup) Method removeCategorygroup.
Categorygroup	removeCategorygroupAt(int index) Method removeCategorygroupAt.
void	setCategorygroup(Categorygroup[] vCategorygroupArray)
void	setCategorygroup(int index, Categorygroup vCategorygroup)
void	setCategorygroup(List<Categorygroup> vCategorygroupList) Sets the value of '_categorygroupList' by copying the given Vector.
void	setCategorygroupCollection(List<Categorygroup> categorygroupList) Deprecated.
void	setHeader(Header header) Sets the value of field 'header'.
static Catinfo	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Catinfo

public Catinfo()

Method Detail

addCategorygroup

public void addCategorygroup(Categorygroup vCategorygroup)
                      throws IndexOutOfBoundsException

Parameters:

vCategorygroup -

Throws:

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

addCategorygroup

public void addCategorygroup(int index,
                             Categorygroup vCategorygroup)
                      throws IndexOutOfBoundsException

Parameters:

index -

vCategorygroup -

Throws:

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

enumerateCategorygroup

public Enumeration<Categorygroup> enumerateCategorygroup()

Method enumerateCategorygroup.

Returns:

an Enumeration over all possible elements of this collection

getCategorygroup

public Categorygroup getCategorygroup(int index)
                               throws IndexOutOfBoundsException

Method getCategorygroup.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.categories.Categorygroup at the given index

Throws:

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

getCategorygroup

public Categorygroup[] getCategorygroup()

Method getCategorygroup.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

getCategorygroupCollection

public List<Categorygroup> getCategorygroupCollection()

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

Returns:

a reference to the Vector backing this class

getCategorygroupCount

public int getCategorygroupCount()

Method getCategorygroupCount.

Returns:

the size of this collection

getHeader

public Header getHeader()

Returns the value of field 'header'. The field 'header' has the following description: Header for this file.

Returns:

the value of field 'Header'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateCategorygroup

public Iterator<Categorygroup> iterateCategorygroup()

Method iterateCategorygroup.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllCategorygroup

public void removeAllCategorygroup()

removeCategorygroup

public boolean removeCategorygroup(Categorygroup vCategorygroup)

Method removeCategorygroup.

Parameters:

vCategorygroup -

Returns:

true if the object was removed from the collection.

removeCategorygroupAt

public Categorygroup removeCategorygroupAt(int index)

Method removeCategorygroupAt.

Parameters:

index -

Returns:

the element removed from the collection

setCategorygroup

public void setCategorygroup(int index,
                             Categorygroup vCategorygroup)
                      throws IndexOutOfBoundsException

Parameters:

index -

vCategorygroup -

Throws:

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

setCategorygroup

public void setCategorygroup(Categorygroup[] vCategorygroupArray)

Parameters:

vCategorygroupArray -

setCategorygroup

public void setCategorygroup(List<Categorygroup> vCategorygroupList)

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

Parameters:

vCategorygroupList - the Vector to copy.

setCategorygroupCollection

public void setCategorygroupCollection(List<Categorygroup> categorygroupList)

Deprecated.

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

Parameters:

categorygroupList - the Vector to set.

setHeader

public void setHeader(Header header)

Sets the value of field 'header'. The field 'header' has the following description: Header for this file.

Parameters:

header - the value of field 'header'.

unmarshal

public static Catinfo unmarshal(Reader reader)
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.categories.Catinfo

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema