org.opennms.netmgt.config.nsclient

Class Wpms

java.lang.Object

org.opennms.netmgt.config.nsclient.Wpms

All Implemented Interfaces:

Serializable

public class Wpms
extends Object
implements Serializable

Nsclient object groups

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Wpms()

Method Summary

Modifier and Type	Method and Description
void	addWpm(int index, Wpm vWpm)
void	addWpm(Wpm vWpm)
Enumeration<Wpm>	enumerateWpm() Method enumerateWpm.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Wpm[]	getWpm() Method getWpm.Returns the contents of the collection in an Array.
Wpm	getWpm(int index) Method getWpm.
List<Wpm>	getWpmCollection() Method getWpmCollection.Returns a reference to '_wpmList'.
int	getWpmCount() Method getWpmCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Wpm>	iterateWpm() Method iterateWpm.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllWpm()
boolean	removeWpm(Wpm vWpm) Method removeWpm.
Wpm	removeWpmAt(int index) Method removeWpmAt.
void	setWpm(int index, Wpm vWpm)
void	setWpm(List<Wpm> vWpmList) Sets the value of '_wpmList' by copying the given Vector.
void	setWpm(Wpm[] vWpmArray)
void	setWpmCollection(List<Wpm> wpmList) Deprecated.
static Wpms	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

Wpms

public Wpms()

Method Detail

addWpm

public void addWpm(Wpm vWpm)
            throws IndexOutOfBoundsException

Parameters:

vWpm -

Throws:

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

addWpm

public void addWpm(int index,
                   Wpm vWpm)
            throws IndexOutOfBoundsException

Parameters:

index -

vWpm -

Throws:

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

enumerateWpm

public Enumeration<Wpm> enumerateWpm()

Method enumerateWpm.

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.

getWpm

public Wpm getWpm(int index)
           throws IndexOutOfBoundsException

Method getWpm.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.nsclient.Wpm at the given index

Throws:

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

getWpm

public Wpm[] getWpm()

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

getWpmCollection

public List<Wpm> getWpmCollection()

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

Returns:

a reference to the Vector backing this class

getWpmCount

public int getWpmCount()

Method getWpmCount.

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

iterateWpm

public Iterator<Wpm> iterateWpm()

Method iterateWpm.

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

removeAllWpm

public void removeAllWpm()

removeWpm

public boolean removeWpm(Wpm vWpm)

Method removeWpm.

Parameters:

vWpm -

Returns:

true if the object was removed from the collection.

removeWpmAt

public Wpm removeWpmAt(int index)

Method removeWpmAt.

Parameters:

index -

Returns:

the element removed from the collection

setWpm

public void setWpm(int index,
                   Wpm vWpm)
            throws IndexOutOfBoundsException

Parameters:

index -

vWpm -

Throws:

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

setWpm

public void setWpm(Wpm[] vWpmArray)

Parameters:

vWpmArray -

setWpm

public void setWpm(List<Wpm> vWpmList)

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

Parameters:

vWpmList - the Vector to copy.

setWpmCollection

public void setWpmCollection(List<Wpm> wpmList)

Deprecated.

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

Parameters:

wpmList - the Vector to set.

unmarshal

public static Wpms 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.nsclient.Wpms

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