org.openoss.opennms.spring.qosd

Class QoSDConfiguration

java.lang.Object

org.openoss.opennms.spring.qosd.QoSDConfiguration

All Implemented Interfaces:

Serializable

public class QoSDConfiguration
extends Object
implements Serializable

Class QoSDConfiguration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QoSDConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSetting(int index, Setting vSetting)
void	addSetting(Setting vSetting)
Enumeration<Setting>	enumerateSetting() Method enumerateSetting.
Eventlist	getEventlist() Returns the value of field 'eventlist'.
Setting[]	getSetting() Method getSetting.Returns the contents of the collection in an Array.
Setting	getSetting(int index) Method getSetting.
List<Setting>	getSettingCollection() Method getSettingCollection.Returns a reference to '_settingList'.
int	getSettingCount() Method getSettingCount.
boolean	isValid() Method isValid.
Iterator<Setting>	iterateSetting() Method iterateSetting.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSetting()
boolean	removeSetting(Setting vSetting) Method removeSetting.
Setting	removeSettingAt(int index) Method removeSettingAt.
void	setEventlist(Eventlist eventlist) Sets the value of field 'eventlist'.
void	setSetting(int index, Setting vSetting)
void	setSetting(List<Setting> vSettingList) Sets the value of '_settingList' by copying the given Vector.
void	setSetting(Setting[] vSettingArray)
void	setSettingCollection(List<Setting> settingList) Deprecated.
static QoSDConfiguration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QoSDConfiguration

public QoSDConfiguration()

Method Detail

addSetting

public void addSetting(Setting vSetting)
                throws IndexOutOfBoundsException

Parameters:

vSetting -

Throws:

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

addSetting

public void addSetting(int index,
              Setting vSetting)
                throws IndexOutOfBoundsException

Parameters:

index -

vSetting -

Throws:

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

enumerateSetting

public Enumeration<Setting> enumerateSetting()

Method enumerateSetting.

Returns:

an Enumeration over all possible elements of this collection

getEventlist

public Eventlist getEventlist()

Returns the value of field 'eventlist'.

Returns:

the value of field 'Eventlist'.

getSetting

public Setting getSetting(int index)
                   throws IndexOutOfBoundsException

Method getSetting.

Parameters:

index -

Returns:

the value of the org.openoss.opennms.spring.qosd.Setting at the given index

Throws:

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

getSetting

public Setting[] getSetting()

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

getSettingCollection

public List<Setting> getSettingCollection()

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

Returns:

a reference to the Vector backing this class

getSettingCount

public int getSettingCount()

Method getSettingCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSetting

public Iterator<Setting> iterateSetting()

Method iterateSetting.

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

removeAllSetting

public void removeAllSetting()

removeSetting

public boolean removeSetting(Setting vSetting)

Method removeSetting.

Parameters:

vSetting -

Returns:

true if the object was removed from the collection.

removeSettingAt

public Setting removeSettingAt(int index)

Method removeSettingAt.

Parameters:

index -

Returns:

the element removed from the collection

setEventlist

public void setEventlist(Eventlist eventlist)

Sets the value of field 'eventlist'.

Parameters:

eventlist - the value of field 'eventlist'.

setSetting

public void setSetting(int index,
              Setting vSetting)
                throws IndexOutOfBoundsException

Parameters:

index -

vSetting -

Throws:

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

setSetting

public void setSetting(Setting[] vSettingArray)

Parameters:

vSettingArray -

setSetting

public void setSetting(List<Setting> vSettingList)

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

Parameters:

vSettingList - the Vector to copy.

setSettingCollection

public void setSettingCollection(List<Setting> settingList)

Deprecated.

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

Parameters:

settingList - the Vector to set.

unmarshal

public static QoSDConfiguration unmarshal(Reader reader)
                                   throws org.exolab.castor.xml.MarshalException,
                                          org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.openoss.opennms.spring.qosd.QoSDConfiguration

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