org.opennms.netmgt.config.tl1d

Class Tl1dConfiguration

java.lang.Object

org.opennms.netmgt.config.tl1d.Tl1dConfiguration

All Implemented Interfaces:

Serializable

public class Tl1dConfiguration
extends Object
implements Serializable

Class Tl1dConfiguration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tl1dConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addTl1Element(int index, Tl1Element vTl1Element)
void	addTl1Element(Tl1Element vTl1Element)
Enumeration<Tl1Element>	enumerateTl1Element() Method enumerateTl1Element.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Tl1Element[]	getTl1Element() Method getTl1Element.Returns the contents of the collection in an Array.
Tl1Element	getTl1Element(int index) Method getTl1Element.
List<Tl1Element>	getTl1ElementCollection() Method getTl1ElementCollection.Returns a reference to '_tl1ElementList'.
int	getTl1ElementCount() Method getTl1ElementCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Tl1Element>	iterateTl1Element() Method iterateTl1Element.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllTl1Element()
boolean	removeTl1Element(Tl1Element vTl1Element) Method removeTl1Element.
Tl1Element	removeTl1ElementAt(int index) Method removeTl1ElementAt.
void	setTl1Element(int index, Tl1Element vTl1Element)
void	setTl1Element(List<Tl1Element> vTl1ElementList) Sets the value of '_tl1ElementList' by copying the given Vector.
void	setTl1Element(Tl1Element[] vTl1ElementArray)
void	setTl1ElementCollection(List<Tl1Element> tl1ElementList) Deprecated.
static Tl1dConfiguration	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

Tl1dConfiguration

public Tl1dConfiguration()

Method Detail

addTl1Element

public void addTl1Element(Tl1Element vTl1Element)
                   throws IndexOutOfBoundsException

Parameters:

vTl1Element -

Throws:

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

addTl1Element

public void addTl1Element(int index,
                          Tl1Element vTl1Element)
                   throws IndexOutOfBoundsException

Parameters:

index -

vTl1Element -

Throws:

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

enumerateTl1Element

public Enumeration<Tl1Element> enumerateTl1Element()

Method enumerateTl1Element.

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.

getTl1Element

public Tl1Element getTl1Element(int index)
                         throws IndexOutOfBoundsException

Method getTl1Element.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.tl1d.Tl1Element at the given index

Throws:

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

getTl1Element

public Tl1Element[] getTl1Element()

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

getTl1ElementCollection

public List<Tl1Element> getTl1ElementCollection()

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

Returns:

a reference to the Vector backing this class

getTl1ElementCount

public int getTl1ElementCount()

Method getTl1ElementCount.

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

iterateTl1Element

public Iterator<Tl1Element> iterateTl1Element()

Method iterateTl1Element.

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

removeAllTl1Element

public void removeAllTl1Element()

removeTl1Element

public boolean removeTl1Element(Tl1Element vTl1Element)

Method removeTl1Element.

Parameters:

vTl1Element -

Returns:

true if the object was removed from the collection.

removeTl1ElementAt

public Tl1Element removeTl1ElementAt(int index)

Method removeTl1ElementAt.

Parameters:

index -

Returns:

the element removed from the collection

setTl1Element

public void setTl1Element(int index,
                          Tl1Element vTl1Element)
                   throws IndexOutOfBoundsException

Parameters:

index -

vTl1Element -

Throws:

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

setTl1Element

public void setTl1Element(Tl1Element[] vTl1ElementArray)

Parameters:

vTl1ElementArray -

setTl1Element

public void setTl1Element(List<Tl1Element> vTl1ElementList)

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

Parameters:

vTl1ElementList - the Vector to copy.

setTl1ElementCollection

public void setTl1ElementCollection(List<Tl1Element> tl1ElementList)

Deprecated.

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

Parameters:

tl1ElementList - the Vector to set.

unmarshal

public static Tl1dConfiguration 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.tl1d.Tl1dConfiguration

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