org.opennms.netmgt.config.nsclient

Class Rrd

java.lang.Object

org.opennms.netmgt.config.nsclient.Rrd

All Implemented Interfaces:

Serializable

public class Rrd
extends Object
implements Serializable

RRD parms

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rrd()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRra(int index, String vRra)
void	addRra(String vRra)
void	deleteStep()
Enumeration<String>	enumerateRra() Method enumerateRra.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String[]	getRra() Method getRra.Returns the contents of the collection in an Array.
String	getRra(int index) Method getRra.
List<String>	getRraCollection() Method getRraCollection.Returns a reference to '_rraList'.
int	getRraCount() Method getRraCount.
int	getStep() Returns the value of field 'step'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasStep() Method hasStep.
boolean	isValid() Method isValid.
Iterator<String>	iterateRra() Method iterateRra.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllRra()
boolean	removeRra(String vRra) Method removeRra.
String	removeRraAt(int index) Method removeRraAt.
void	setRra(int index, String vRra)
void	setRra(List<String> vRraList) Sets the value of '_rraList' by copying the given Vector.
void	setRra(String[] vRraArray)
void	setRraCollection(List<String> rraList) Deprecated.
void	setStep(int step) Sets the value of field 'step'.
static Rrd	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

Rrd

public Rrd()

Method Detail

addRra

public void addRra(String vRra)
            throws IndexOutOfBoundsException

Parameters:

vRra -

Throws:

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

addRra

public void addRra(int index,
          String vRra)
            throws IndexOutOfBoundsException

Parameters:

index -

vRra -

Throws:

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

deleteStep

public void deleteStep()

enumerateRra

public Enumeration<String> enumerateRra()

Method enumerateRra.

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.

getRra

public String getRra(int index)
              throws IndexOutOfBoundsException

Method getRra.

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

getRra

public String[] getRra()

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

getRraCollection

public List<String> getRraCollection()

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

Returns:

a reference to the Vector backing this class

getRraCount

public int getRraCount()

Method getRraCount.

Returns:

the size of this collection

getStep

public int getStep()

Returns the value of field 'step'. The field 'step' has the following description: step size for the RRD

Returns:

the value of field 'Step'.

hasStep

public boolean hasStep()

Method hasStep.

Returns:

true if at least one Step 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

iterateRra

public Iterator<String> iterateRra()

Method iterateRra.

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

removeAllRra

public void removeAllRra()

removeRra

public boolean removeRra(String vRra)

Method removeRra.

Parameters:

vRra -

Returns:

true if the object was removed from the collection.

removeRraAt

public String removeRraAt(int index)

Method removeRraAt.

Parameters:

index -

Returns:

the element removed from the collection

setRra

public void setRra(int index,
          String vRra)
            throws IndexOutOfBoundsException

Parameters:

index -

vRra -

Throws:

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

setRra

public void setRra(String[] vRraArray)

Parameters:

vRraArray -

setRra

public void setRra(List<String> vRraList)

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

Parameters:

vRraList - the Vector to copy.

setRraCollection

public void setRraCollection(List<String> rraList)

Deprecated.

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

Parameters:

rraList - the Vector to set.

setStep

public void setStep(int step)

Sets the value of field 'step'. The field 'step' has the following description: step size for the RRD

Parameters:

step - the value of field 'step'.

unmarshal

public static Rrd 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.Rr

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