org.opennms.netmgt.config.datacollection
Class IncludeCollection

java.lang.Object
  org.opennms.netmgt.config.datacollection.IncludeCollection

All Implemented Interfaces:

Serializable

public class IncludeCollection
extends Object
implements Serializable

Class IncludeCollection.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

IncludeCollection()

Method Summary

void	addExcludeFilter(int index, String vExcludeFilter)
void	addExcludeFilter(String vExcludeFilter)
Enumeration<String>	enumerateExcludeFilter() Method enumerateExcludeFilter.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDataCollectionGroup() Returns the value of field 'dataCollectionGroup'.
String[]	getExcludeFilter() Method getExcludeFilter.Returns the contents of the collection in an Array.
String	getExcludeFilter(int index) Method getExcludeFilter.
List<String>	getExcludeFilterCollection() Method getExcludeFilterCollection.Returns a reference to '_excludeFilterList'.
int	getExcludeFilterCount() Method getExcludeFilterCount.
String	getSystemDef() Returns the value of field 'systemDef'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<String>	iterateExcludeFilter() Method iterateExcludeFilter.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllExcludeFilter()
boolean	removeExcludeFilter(String vExcludeFilter) Method removeExcludeFilter.
String	removeExcludeFilterAt(int index) Method removeExcludeFilterAt.
void	setDataCollectionGroup(String dataCollectionGroup) Sets the value of field 'dataCollectionGroup'.
void	setExcludeFilter(int index, String vExcludeFilter)
void	setExcludeFilter(List<String> vExcludeFilterList) Sets the value of '_excludeFilterList' by copying the given Vector.
void	setExcludeFilter(String[] vExcludeFilterArray)
void	setExcludeFilterCollection(List<String> excludeFilterList) Deprecated.
void	setSystemDef(String systemDef) Sets the value of field 'systemDef'.
static IncludeCollection	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

IncludeCollection

public IncludeCollection()

Method Detail

addExcludeFilter

public void addExcludeFilter(String vExcludeFilter)
                      throws IndexOutOfBoundsException

Parameters:

vExcludeFilter -

Throws:

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

addExcludeFilter

public void addExcludeFilter(int index,
                             String vExcludeFilter)
                      throws IndexOutOfBoundsException

Parameters:

index -

vExcludeFilter -

Throws:

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

enumerateExcludeFilter

public Enumeration<String> enumerateExcludeFilter()

Method enumerateExcludeFilter.

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.

getDataCollectionGroup

public String getDataCollectionGroup()

Returns the value of field 'dataCollectionGroup'. The field 'dataCollectionGroup' has the following description: Data Collection Group Name

Returns:

the value of field 'DataCollectionGroup'.

getExcludeFilter

public String getExcludeFilter(int index)
                        throws IndexOutOfBoundsException

Method getExcludeFilter.

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

getExcludeFilter

public String[] getExcludeFilter()

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

getExcludeFilterCollection

public List<String> getExcludeFilterCollection()

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

Returns:

a reference to the Vector backing this class

getExcludeFilterCount

public int getExcludeFilterCount()

Method getExcludeFilterCount.

Returns:

the size of this collection

getSystemDef

public String getSystemDef()

Returns the value of field 'systemDef'. The field 'systemDef' has the following description: System Definition Name

Returns:

the value of field 'SystemDef'.

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

iterateExcludeFilter

public Iterator<String> iterateExcludeFilter()

Method iterateExcludeFilter.

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

removeAllExcludeFilter

public void removeAllExcludeFilter()

removeExcludeFilter

public boolean removeExcludeFilter(String vExcludeFilter)

Method removeExcludeFilter.

Parameters:

vExcludeFilter -

Returns:

true if the object was removed from the collection.

removeExcludeFilterAt

public String removeExcludeFilterAt(int index)

Method removeExcludeFilterAt.

Parameters:

index -

Returns:

the element removed from the collection

setDataCollectionGroup

public void setDataCollectionGroup(String dataCollectionGroup)

Sets the value of field 'dataCollectionGroup'. The field 'dataCollectionGroup' has the following description: Data Collection Group Name

Parameters:

dataCollectionGroup - the value of field 'dataCollectionGroup'.

setExcludeFilter

public void setExcludeFilter(int index,
                             String vExcludeFilter)
                      throws IndexOutOfBoundsException

Parameters:

index -

vExcludeFilter -

Throws:

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

setExcludeFilter

public void setExcludeFilter(String[] vExcludeFilterArray)

Parameters:

vExcludeFilterArray -

setExcludeFilter

public void setExcludeFilter(List<String> vExcludeFilterList)

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

Parameters:

vExcludeFilterList - the Vector to copy.

setExcludeFilterCollection

public void setExcludeFilterCollection(List<String> excludeFilterList)

Deprecated.

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

Parameters:

excludeFilterList - the Vector to set.

setSystemDef

public void setSystemDef(String systemDef)

Sets the value of field 'systemDef'. The field 'systemDef' has the following description: System Definition Name

Parameters:

systemDef - the value of field 'systemDef'.

unmarshal

public static IncludeCollection 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.datacollection.IncludeCollection

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