org.opennms.netmgt.config.viewsdisplay

Class Section

java.lang.Object

org.opennms.netmgt.config.viewsdisplay.Section

All Implemented Interfaces:

Serializable

public class Section
extends Object
implements Serializable

Class Section.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Section()

Method Summary

Modifier and Type	Method and Description
void	addCategory(int index, String vCategory)
void	addCategory(String vCategory)
Enumeration<String>	enumerateCategory() Method enumerateCategory.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String[]	getCategory() Method getCategory.Returns the contents of the collection in an Array.
String	getCategory(int index) Method getCategory.
List<String>	getCategoryCollection() Method getCategoryCollection.Returns a reference to '_categoryList'.
int	getCategoryCount() Method getCategoryCount.
String	getSectionName() Returns the value of field 'sectionName'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<String>	iterateCategory() Method iterateCategory.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllCategory()
boolean	removeCategory(String vCategory) Method removeCategory.
String	removeCategoryAt(int index) Method removeCategoryAt.
void	setCategory(int index, String vCategory)
void	setCategory(List<String> vCategoryList) Sets the value of '_categoryList' by copying the given Vector.
void	setCategory(String[] vCategoryArray)
void	setCategoryCollection(List<String> categoryList) Deprecated.
void	setSectionName(String sectionName) Sets the value of field 'sectionName'.
static Section	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

public Section()

Method Detail

addCategory

public void addCategory(String vCategory)
                 throws IndexOutOfBoundsException

Parameters:

vCategory -

Throws:

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

addCategory

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

Parameters:

index -

vCategory -

Throws:

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

enumerateCategory

public Enumeration<String> enumerateCategory()

Method enumerateCategory.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getCategory

public String getCategory(int index)
                   throws IndexOutOfBoundsException

Method getCategory.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getCategory

public String[] 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<String> 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

getSectionName

public String getSectionName()

Returns the value of field 'sectionName'.

Returns:

the value of field 'SectionName'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateCategory

public Iterator<String> iterateCategory()

Method iterateCategory.

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

removeAllCategory

public void removeAllCategory()

removeCategory

public boolean removeCategory(String vCategory)

Method removeCategory.

Parameters:

vCategory -

Returns:

true if the object was removed from the collection.

removeCategoryAt

public String removeCategoryAt(int index)

Method removeCategoryAt.

Parameters:

index -

Returns:

the element removed from the collection

setCategory

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

Parameters:

index -

vCategory -

Throws:

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

setCategory

public void setCategory(String[] vCategoryArray)

Parameters:

vCategoryArray -

setCategory

public void setCategory(List<String> 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<String> 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.

setSectionName

public void setSectionName(String sectionName)

Sets the value of field 'sectionName'.

Parameters:

sectionName - the value of field 'sectionName'.

unmarshal

public static Section 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.viewsdisplay.Section

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