org.opennms.netmgt.config.viewsdisplay

Class View

java.lang.Object

org.opennms.netmgt.config.viewsdisplay.View

All Implemented Interfaces:

Serializable

public class View
extends Object
implements Serializable

Class View.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
View()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSection(int index, Section vSection)
void	addSection(Section vSection)
Enumeration<Section>	enumerateSection() Method enumerateSection.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Section[]	getSection() Method getSection.Returns the contents of the collection in an Array.
Section	getSection(int index) Method getSection.
List<Section>	getSectionCollection() Method getSectionCollection.Returns a reference to '_sectionList'.
int	getSectionCount() Method getSectionCount.
String	getViewName() Returns the value of field 'viewName'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Section>	iterateSection() Method iterateSection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSection()
boolean	removeSection(Section vSection) Method removeSection.
Section	removeSectionAt(int index) Method removeSectionAt.
void	setSection(int index, Section vSection)
void	setSection(List<Section> vSectionList) Sets the value of '_sectionList' by copying the given Vector.
void	setSection(Section[] vSectionArray)
void	setSectionCollection(List<Section> sectionList) Deprecated.
void	setViewName(String viewName) Sets the value of field 'viewName'.
static View	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

View

public View()

Method Detail

addSection

public void addSection(Section vSection)
                throws IndexOutOfBoundsException

Parameters:

vSection -

Throws:

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

addSection

public void addSection(int index,
              Section vSection)
                throws IndexOutOfBoundsException

Parameters:

index -

vSection -

Throws:

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

enumerateSection

public Enumeration<Section> enumerateSection()

Method enumerateSection.

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.

getSection

public Section getSection(int index)
                   throws IndexOutOfBoundsException

Method getSection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.viewsdisplay.Section at the given index

Throws:

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

getSection

public Section[] getSection()

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

getSectionCollection

public List<Section> getSectionCollection()

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

Returns:

a reference to the Vector backing this class

getSectionCount

public int getSectionCount()

Method getSectionCount.

Returns:

the size of this collection

getViewName

public String getViewName()

Returns the value of field 'viewName'.

Returns:

the value of field 'ViewName'.

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

iterateSection

public Iterator<Section> iterateSection()

Method iterateSection.

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

removeAllSection

public void removeAllSection()

removeSection

public boolean removeSection(Section vSection)

Method removeSection.

Parameters:

vSection -

Returns:

true if the object was removed from the collection.

removeSectionAt

public Section removeSectionAt(int index)

Method removeSectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setSection

public void setSection(int index,
              Section vSection)
                throws IndexOutOfBoundsException

Parameters:

index -

vSection -

Throws:

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

setSection

public void setSection(Section[] vSectionArray)

Parameters:

vSectionArray -

setSection

public void setSection(List<Section> vSectionList)

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

Parameters:

vSectionList - the Vector to copy.

setSectionCollection

public void setSectionCollection(List<Section> sectionList)

Deprecated.

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

Parameters:

sectionList - the Vector to set.

setViewName

public void setViewName(String viewName)

Sets the value of field 'viewName'.

Parameters:

viewName - the value of field 'viewName'.

unmarshal

public static View 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.View

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