org.opennms.netmgt.config.reporting
Class Parameters

java.lang.Object
  org.opennms.netmgt.config.reporting.Parameters

All Implemented Interfaces:

Serializable

public class Parameters
extends Object
implements Serializable

Class Parameters.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Parameters()

Method Summary

void	addDateParm(DateParm vDateParm)
void	addDateParm(int index, DateParm vDateParm)
void	addIntParm(int index, IntParm vIntParm)
void	addIntParm(IntParm vIntParm)
void	addStringParm(int index, StringParm vStringParm)
void	addStringParm(StringParm vStringParm)
Enumeration<DateParm>	enumerateDateParm() Method enumerateDateParm.
Enumeration<IntParm>	enumerateIntParm() Method enumerateIntParm.
Enumeration<StringParm>	enumerateStringParm() Method enumerateStringParm.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
DateParm[]	getDateParm() Method getDateParm.Returns the contents of the collection in an Array.
DateParm	getDateParm(int index) Method getDateParm.
List<DateParm>	getDateParmCollection() Method getDateParmCollection.Returns a reference to '_dateParmList'.
int	getDateParmCount() Method getDateParmCount.
IntParm[]	getIntParm() Method getIntParm.Returns the contents of the collection in an Array.
IntParm	getIntParm(int index) Method getIntParm.
List<IntParm>	getIntParmCollection() Method getIntParmCollection.Returns a reference to '_intParmList'.
int	getIntParmCount() Method getIntParmCount.
StringParm[]	getStringParm() Method getStringParm.Returns the contents of the collection in an Array.
StringParm	getStringParm(int index) Method getStringParm.
List<StringParm>	getStringParmCollection() Method getStringParmCollection.Returns a reference to '_stringParmList'.
int	getStringParmCount() Method getStringParmCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<DateParm>	iterateDateParm() Method iterateDateParm.
Iterator<IntParm>	iterateIntParm() Method iterateIntParm.
Iterator<StringParm>	iterateStringParm() Method iterateStringParm.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDateParm()
void	removeAllIntParm()
void	removeAllStringParm()
boolean	removeDateParm(DateParm vDateParm) Method removeDateParm.
DateParm	removeDateParmAt(int index) Method removeDateParmAt.
boolean	removeIntParm(IntParm vIntParm) Method removeIntParm.
IntParm	removeIntParmAt(int index) Method removeIntParmAt.
boolean	removeStringParm(StringParm vStringParm) Method removeStringParm.
StringParm	removeStringParmAt(int index) Method removeStringParmAt.
void	setDateParm(DateParm[] vDateParmArray)
void	setDateParm(int index, DateParm vDateParm)
void	setDateParm(List<DateParm> vDateParmList) Sets the value of '_dateParmList' by copying the given Vector.
void	setDateParmCollection(List<DateParm> dateParmList) Deprecated.
void	setIntParm(int index, IntParm vIntParm)
void	setIntParm(IntParm[] vIntParmArray)
void	setIntParm(List<IntParm> vIntParmList) Sets the value of '_intParmList' by copying the given Vector.
void	setIntParmCollection(List<IntParm> intParmList) Deprecated.
void	setStringParm(int index, StringParm vStringParm)
void	setStringParm(List<StringParm> vStringParmList) Sets the value of '_stringParmList' by copying the given Vector.
void	setStringParm(StringParm[] vStringParmArray)
void	setStringParmCollection(List<StringParm> stringParmList) Deprecated.
static Parameters	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

Parameters

public Parameters()

Method Detail

addDateParm

public void addDateParm(DateParm vDateParm)
                 throws IndexOutOfBoundsException

Parameters:

vDateParm -

Throws:

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

addDateParm

public void addDateParm(int index,
                        DateParm vDateParm)
                 throws IndexOutOfBoundsException

Parameters:

index -

vDateParm -

Throws:

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

addIntParm

public void addIntParm(IntParm vIntParm)
                throws IndexOutOfBoundsException

Parameters:

vIntParm -

Throws:

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

addIntParm

public void addIntParm(int index,
                       IntParm vIntParm)
                throws IndexOutOfBoundsException

Parameters:

index -

vIntParm -

Throws:

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

addStringParm

public void addStringParm(StringParm vStringParm)
                   throws IndexOutOfBoundsException

Parameters:

vStringParm -

Throws:

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

addStringParm

public void addStringParm(int index,
                          StringParm vStringParm)
                   throws IndexOutOfBoundsException

Parameters:

index -

vStringParm -

Throws:

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

enumerateDateParm

public Enumeration<DateParm> enumerateDateParm()

Method enumerateDateParm.

Returns:

an Enumeration over all possible elements of this collection

enumerateIntParm

public Enumeration<IntParm> enumerateIntParm()

Method enumerateIntParm.

Returns:

an Enumeration over all possible elements of this collection

enumerateStringParm

public Enumeration<StringParm> enumerateStringParm()

Method enumerateStringParm.

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.

getDateParm

public DateParm getDateParm(int index)
                     throws IndexOutOfBoundsException

Method getDateParm.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.reporting.DateParm at the given index

Throws:

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

getDateParm

public DateParm[] getDateParm()

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

getDateParmCollection

public List<DateParm> getDateParmCollection()

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

Returns:

a reference to the Vector backing this class

getDateParmCount

public int getDateParmCount()

Method getDateParmCount.

Returns:

the size of this collection

getIntParm

public IntParm getIntParm(int index)
                   throws IndexOutOfBoundsException

Method getIntParm.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.reporting.IntParm at the given inde

Throws:

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

getIntParm

public IntParm[] getIntParm()

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

getIntParmCollection

public List<IntParm> getIntParmCollection()

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

Returns:

a reference to the Vector backing this class

getIntParmCount

public int getIntParmCount()

Method getIntParmCount.

Returns:

the size of this collection

getStringParm

public StringParm getStringParm(int index)
                         throws IndexOutOfBoundsException

Method getStringParm.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.reporting.StringParm at the given index

Throws:

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

getStringParm

public StringParm[] getStringParm()

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

getStringParmCollection

public List<StringParm> getStringParmCollection()

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

Returns:

a reference to the Vector backing this class

getStringParmCount

public int getStringParmCount()

Method getStringParmCount.

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

iterateDateParm

public Iterator<DateParm> iterateDateParm()

Method iterateDateParm.

Returns:

an Iterator over all possible elements in this collection

iterateIntParm

public Iterator<IntParm> iterateIntParm()

Method iterateIntParm.

Returns:

an Iterator over all possible elements in this collection

iterateStringParm

public Iterator<StringParm> iterateStringParm()

Method iterateStringParm.

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

removeAllDateParm

public void removeAllDateParm()

removeAllIntParm

public void removeAllIntParm()

removeAllStringParm

public void removeAllStringParm()

removeDateParm

public boolean removeDateParm(DateParm vDateParm)

Method removeDateParm.

Parameters:

vDateParm -

Returns:

true if the object was removed from the collection.

removeDateParmAt

public DateParm removeDateParmAt(int index)

Method removeDateParmAt.

Parameters:

index -

Returns:

the element removed from the collection

removeIntParm

public boolean removeIntParm(IntParm vIntParm)

Method removeIntParm.

Parameters:

vIntParm -

Returns:

true if the object was removed from the collection.

removeIntParmAt

public IntParm removeIntParmAt(int index)

Method removeIntParmAt.

Parameters:

index -

Returns:

the element removed from the collection

removeStringParm

public boolean removeStringParm(StringParm vStringParm)

Method removeStringParm.

Parameters:

vStringParm -

Returns:

true if the object was removed from the collection.

removeStringParmAt

public StringParm removeStringParmAt(int index)

Method removeStringParmAt.

Parameters:

index -

Returns:

the element removed from the collection

setDateParm

public void setDateParm(int index,
                        DateParm vDateParm)
                 throws IndexOutOfBoundsException

Parameters:

index -

vDateParm -

Throws:

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

setDateParm

public void setDateParm(DateParm[] vDateParmArray)

Parameters:

vDateParmArray -

setDateParm

public void setDateParm(List<DateParm> vDateParmList)

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

Parameters:

vDateParmList - the Vector to copy.

setDateParmCollection

public void setDateParmCollection(List<DateParm> dateParmList)

Deprecated.

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

Parameters:

dateParmList - the Vector to set.

setIntParm

public void setIntParm(int index,
                       IntParm vIntParm)
                throws IndexOutOfBoundsException

Parameters:

index -

vIntParm -

Throws:

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

setIntParm

public void setIntParm(IntParm[] vIntParmArray)

Parameters:

vIntParmArray -

setIntParm

public void setIntParm(List<IntParm> vIntParmList)

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

Parameters:

vIntParmList - the Vector to copy.

setIntParmCollection

public void setIntParmCollection(List<IntParm> intParmList)

Deprecated.

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

Parameters:

intParmList - the Vector to set.

setStringParm

public void setStringParm(int index,
                          StringParm vStringParm)
                   throws IndexOutOfBoundsException

Parameters:

index -

vStringParm -

Throws:

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

setStringParm

public void setStringParm(StringParm[] vStringParmArray)

Parameters:

vStringParmArray -

setStringParm

public void setStringParm(List<StringParm> vStringParmList)

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

Parameters:

vStringParmList - the Vector to copy.

setStringParmCollection

public void setStringParmCollection(List<StringParm> stringParmList)

Deprecated.

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

Parameters:

stringParmList - the Vector to set.

unmarshal

public static Parameters 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.reporting.Parameters

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