org.opennms.netmgt.config.surveillanceViews

Class Columns

java.lang.Object

org.opennms.netmgt.config.surveillanceViews.Columns

All Implemented Interfaces:

Serializable

public class Columns
extends Object
implements Serializable

Class Columns.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Columns()

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumnDef(ColumnDef vColumnDef)
void	addColumnDef(int index, ColumnDef vColumnDef)
Enumeration<ColumnDef>	enumerateColumnDef() Method enumerateColumnDef.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
ColumnDef[]	getColumnDef() Method getColumnDef.Returns the contents of the collection in an Array.
ColumnDef	getColumnDef(int index) Method getColumnDef.
List<ColumnDef>	getColumnDefCollection() Method getColumnDefCollection.Returns a reference to '_columnDefList'.
int	getColumnDefCount() Method getColumnDefCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<ColumnDef>	iterateColumnDef() Method iterateColumnDef.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllColumnDef()
boolean	removeColumnDef(ColumnDef vColumnDef) Method removeColumnDef.
ColumnDef	removeColumnDefAt(int index) Method removeColumnDefAt.
void	setColumnDef(ColumnDef[] vColumnDefArray)
void	setColumnDef(int index, ColumnDef vColumnDef)
void	setColumnDef(List<ColumnDef> vColumnDefList) Sets the value of '_columnDefList' by copying the given Vector.
void	setColumnDefCollection(List<ColumnDef> columnDefList) Deprecated.
static Columns	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

Columns

public Columns()

Method Detail

addColumnDef

public void addColumnDef(ColumnDef vColumnDef)
                  throws IndexOutOfBoundsException

Parameters:

vColumnDef -

Throws:

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

addColumnDef

public void addColumnDef(int index,
                ColumnDef vColumnDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vColumnDef -

Throws:

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

enumerateColumnDef

public Enumeration<ColumnDef> enumerateColumnDef()

Method enumerateColumnDef.

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.

getColumnDef

public ColumnDef getColumnDef(int index)
                       throws IndexOutOfBoundsException

Method getColumnDef.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.surveillanceViews.ColumnDef at the given index

Throws:

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

getColumnDef

public ColumnDef[] getColumnDef()

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

getColumnDefCollection

public List<ColumnDef> getColumnDefCollection()

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

Returns:

a reference to the Vector backing this class

getColumnDefCount

public int getColumnDefCount()

Method getColumnDefCount.

Returns:

the size of this collection

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

iterateColumnDef

public Iterator<ColumnDef> iterateColumnDef()

Method iterateColumnDef.

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

removeAllColumnDef

public void removeAllColumnDef()

removeColumnDef

public boolean removeColumnDef(ColumnDef vColumnDef)

Method removeColumnDef.

Parameters:

vColumnDef -

Returns:

true if the object was removed from the collection.

removeColumnDefAt

public ColumnDef removeColumnDefAt(int index)

Method removeColumnDefAt.

Parameters:

index -

Returns:

the element removed from the collection

setColumnDef

public void setColumnDef(int index,
                ColumnDef vColumnDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vColumnDef -

Throws:

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

setColumnDef

public void setColumnDef(ColumnDef[] vColumnDefArray)

Parameters:

vColumnDefArray -

setColumnDef

public void setColumnDef(List<ColumnDef> vColumnDefList)

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

Parameters:

vColumnDefList - the Vector to copy.

setColumnDefCollection

public void setColumnDefCollection(List<ColumnDef> columnDefList)

Deprecated.

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

Parameters:

columnDefList - the Vector to set.

unmarshal

public static Columns 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.surveillanceViews.Columns

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