org.opennms.reporting.availability

Class Col

java.lang.Object

org.opennms.reporting.availability.Col

All Implemented Interfaces:

Serializable

public class Col
extends Object
implements Serializable

Class Col.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Col()

Method Summary

Methods

Modifier and Type	Method and Description
void	addColTitle(int index, String vColTitle)
void	addColTitle(String vColTitle)
Enumeration<String>	enumerateColTitle() Method enumerateColTitle.
String[]	getColTitle() Method getColTitle.Returns the contents of the collection in an Array.
String	getColTitle(int index) Method getColTitle.
List<String>	getColTitleCollection() Method getColTitleCollection.Returns a reference to '_colTitleList'.
int	getColTitleCount() Method getColTitleCount.
boolean	isValid() Method isValid.
Iterator<String>	iterateColTitle() Method iterateColTitle.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllColTitle()
boolean	removeColTitle(String vColTitle) Method removeColTitle.
String	removeColTitleAt(int index) Method removeColTitleAt.
void	setColTitle(int index, String vColTitle)
void	setColTitle(List<String> vColTitleList) Sets the value of '_colTitleList' by copying the given Vector.
void	setColTitle(String[] vColTitleArray)
void	setColTitleCollection(List<String> colTitleList) Deprecated.
static Col	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

Col

public Col()

Method Detail

addColTitle

public void addColTitle(String vColTitle)
                 throws IndexOutOfBoundsException

Parameters:

vColTitle -

Throws:

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

addColTitle

public void addColTitle(int index,
               String vColTitle)
                 throws IndexOutOfBoundsException

Parameters:

index -

vColTitle -

Throws:

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

enumerateColTitle

public Enumeration<String> enumerateColTitle()

Method enumerateColTitle.

Returns:

an Enumeration over all possible elements of this collection

getColTitle

public String getColTitle(int index)
                   throws IndexOutOfBoundsException

Method getColTitle.

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

getColTitle

public String[] getColTitle()

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

getColTitleCollection

public List<String> getColTitleCollection()

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

Returns:

a reference to the Vector backing this class

getColTitleCount

public int getColTitleCount()

Method getColTitleCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateColTitle

public Iterator<String> iterateColTitle()

Method iterateColTitle.

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

removeAllColTitle

public void removeAllColTitle()

removeColTitle

public boolean removeColTitle(String vColTitle)

Method removeColTitle.

Parameters:

vColTitle -

Returns:

true if the object was removed from the collection.

removeColTitleAt

public String removeColTitleAt(int index)

Method removeColTitleAt.

Parameters:

index -

Returns:

the element removed from the collection

setColTitle

public void setColTitle(int index,
               String vColTitle)
                 throws IndexOutOfBoundsException

Parameters:

index -

vColTitle -

Throws:

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

setColTitle

public void setColTitle(String[] vColTitleArray)

Parameters:

vColTitleArray -

setColTitle

public void setColTitle(List<String> vColTitleList)

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

Parameters:

vColTitleList - the Vector to copy.

setColTitleCollection

public void setColTitleCollection(List<String> colTitleList)

Deprecated.

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

Parameters:

colTitleList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.reporting.availability.Co

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