org.opennms.netmgt.config.nsclient

Class Wpm

java.lang.Object

org.opennms.netmgt.config.nsclient.Wpm

All Implemented Interfaces:

Serializable

public class Wpm
extends Object
implements Serializable

An NSClient Object Group

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Wpm()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttrib(Attrib vAttrib)
void	addAttrib(int index, Attrib vAttrib)
void	deleteRecheckInterval()
Enumeration<Attrib>	enumerateAttrib() Method enumerateAttrib.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Attrib[]	getAttrib() Method getAttrib.Returns the contents of the collection in an Array.
Attrib	getAttrib(int index) Method getAttrib.
List<Attrib>	getAttribCollection() Method getAttribCollection.Returns a reference to '_attribList'.
int	getAttribCount() Method getAttribCount.
String	getKeyvalue() Returns the value of field 'keyvalue'.
String	getName() Returns the value of field 'name'.
int	getRecheckInterval() Returns the value of field 'recheckInterval'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasRecheckInterval() Method hasRecheckInterval.
boolean	isValid() Method isValid.
Iterator<Attrib>	iterateAttrib() Method iterateAttrib.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAttrib()
boolean	removeAttrib(Attrib vAttrib) Method removeAttrib.
Attrib	removeAttribAt(int index) Method removeAttribAt.
void	setAttrib(Attrib[] vAttribArray)
void	setAttrib(int index, Attrib vAttrib)
void	setAttrib(List<Attrib> vAttribList) Sets the value of '_attribList' by copying the given Vector.
void	setAttribCollection(List<Attrib> attribList) Deprecated.
void	setKeyvalue(String keyvalue) Sets the value of field 'keyvalue'.
void	setName(String name) Sets the value of field 'name'.
void	setRecheckInterval(int recheckInterval) Sets the value of field 'recheckInterval'.
static Wpm	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

Wpm

public Wpm()

Method Detail

addAttrib

public void addAttrib(Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

vAttrib -

Throws:

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

addAttrib

public void addAttrib(int index,
             Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

index -

vAttrib -

Throws:

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

deleteRecheckInterval

public void deleteRecheckInterval()

enumerateAttrib

public Enumeration<Attrib> enumerateAttrib()

Method enumerateAttrib.

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.

getAttrib

public Attrib getAttrib(int index)
                 throws IndexOutOfBoundsException

Method getAttrib.

Parameters:

index -

Returns:

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

Throws:

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

getAttrib

public Attrib[] getAttrib()

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

getAttribCollection

public List<Attrib> getAttribCollection()

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

Returns:

a reference to the Vector backing this class

getAttribCount

public int getAttribCount()

Method getAttribCount.

Returns:

the size of this collection

getKeyvalue

public String getKeyvalue()

Returns the value of field 'keyvalue'. The field 'keyvalue' has the following description: The Key value which, if present, indicates that the rest of this group should be collected

Returns:

the value of field 'Keyvalue'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: The name of this group, for user id purposes

Returns:

the value of field 'Name'.

getRecheckInterval

public int getRecheckInterval()

Returns the value of field 'recheckInterval'. The field 'recheckInterval' has the following description: Specifies how often the key value of this group should be rechecked for existence. In milliseconds

Returns:

the value of field 'RecheckInterval'.

hasRecheckInterval

public boolean hasRecheckInterval()

Method hasRecheckInterval.

Returns:

true if at least one RecheckInterval has been added

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

iterateAttrib

public Iterator<Attrib> iterateAttrib()

Method iterateAttrib.

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

removeAllAttrib

public void removeAllAttrib()

removeAttrib

public boolean removeAttrib(Attrib vAttrib)

Method removeAttrib.

Parameters:

vAttrib -

Returns:

true if the object was removed from the collection.

removeAttribAt

public Attrib removeAttribAt(int index)

Method removeAttribAt.

Parameters:

index -

Returns:

the element removed from the collection

setAttrib

public void setAttrib(int index,
             Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

index -

vAttrib -

Throws:

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

setAttrib

public void setAttrib(Attrib[] vAttribArray)

Parameters:

vAttribArray -

setAttrib

public void setAttrib(List<Attrib> vAttribList)

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

Parameters:

vAttribList - the Vector to copy.

setAttribCollection

public void setAttribCollection(List<Attrib> attribList)

Deprecated.

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

Parameters:

attribList - the Vector to set.

setKeyvalue

public void setKeyvalue(String keyvalue)

Sets the value of field 'keyvalue'. The field 'keyvalue' has the following description: The Key value which, if present, indicates that the rest of this group should be collected

Parameters:

keyvalue - the value of field 'keyvalue'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: The name of this group, for user id purposes

Parameters:

name - the value of field 'name'.

setRecheckInterval

public void setRecheckInterval(int recheckInterval)

Sets the value of field 'recheckInterval'. The field 'recheckInterval' has the following description: Specifies how often the key value of this group should be rechecked for existence. In milliseconds

Parameters:

recheckInterval - the value of field 'recheckInterval'.

unmarshal

public static Wpm 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.Wp

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