org.opennms.netmgt.config.map.adapter
Class Package

java.lang.Object
  org.opennms.netmgt.config.map.adapter.Package

All Implemented Interfaces:

Serializable

public class Package
extends Object
implements Serializable

Package encapsulating addresses, services to be polled for these addresses, etc..

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Package()

Method Summary

void	addExcludeRange(ExcludeRange vExcludeRange)
void	addExcludeRange(int index, ExcludeRange vExcludeRange)
void	addIncludeRange(IncludeRange vIncludeRange)
void	addIncludeRange(int index, IncludeRange vIncludeRange)
void	addIncludeUrl(int index, String vIncludeUrl)
void	addIncludeUrl(String vIncludeUrl)
void	addSpecific(int index, String vSpecific)
void	addSpecific(String vSpecific)
Enumeration<ExcludeRange>	enumerateExcludeRange() Method enumerateExcludeRange.
Enumeration<IncludeRange>	enumerateIncludeRange() Method enumerateIncludeRange.
Enumeration<String>	enumerateIncludeUrl() Method enumerateIncludeUrl.
Enumeration<String>	enumerateSpecific() Method enumerateSpecific.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
ExcludeRange[]	getExcludeRange() Method getExcludeRange.Returns the contents of the collection in an Array.
ExcludeRange	getExcludeRange(int index) Method getExcludeRange.
List<ExcludeRange>	getExcludeRangeCollection() Method getExcludeRangeCollection.Returns a reference to '_excludeRangeList'.
int	getExcludeRangeCount() Method getExcludeRangeCount.
Filter	getFilter() Returns the value of field 'filter'.
IncludeRange[]	getIncludeRange() Method getIncludeRange.Returns the contents of the collection in an Array.
IncludeRange	getIncludeRange(int index) Method getIncludeRange.
List<IncludeRange>	getIncludeRangeCollection() Method getIncludeRangeCollection.Returns a reference to '_includeRangeList'.
int	getIncludeRangeCount() Method getIncludeRangeCount.
String[]	getIncludeUrl() Method getIncludeUrl.Returns the contents of the collection in an Array.
String	getIncludeUrl(int index) Method getIncludeUrl.
List<String>	getIncludeUrlCollection() Method getIncludeUrlCollection.Returns a reference to '_includeUrlList'.
int	getIncludeUrlCount() Method getIncludeUrlCount.
String	getName() Returns the value of field 'name'.
String[]	getSpecific() Method getSpecific.Returns the contents of the collection in an Array.
String	getSpecific(int index) Method getSpecific.
List<String>	getSpecificCollection() Method getSpecificCollection.Returns a reference to '_specificList'.
int	getSpecificCount() Method getSpecificCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<ExcludeRange>	iterateExcludeRange() Method iterateExcludeRange.
Iterator<IncludeRange>	iterateIncludeRange() Method iterateIncludeRange.
Iterator<String>	iterateIncludeUrl() Method iterateIncludeUrl.
Iterator<String>	iterateSpecific() Method iterateSpecific.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllExcludeRange()
void	removeAllIncludeRange()
void	removeAllIncludeUrl()
void	removeAllSpecific()
boolean	removeExcludeRange(ExcludeRange vExcludeRange) Method removeExcludeRange.
ExcludeRange	removeExcludeRangeAt(int index) Method removeExcludeRangeAt.
boolean	removeIncludeRange(IncludeRange vIncludeRange) Method removeIncludeRange.
IncludeRange	removeIncludeRangeAt(int index) Method removeIncludeRangeAt.
boolean	removeIncludeUrl(String vIncludeUrl) Method removeIncludeUrl.
String	removeIncludeUrlAt(int index) Method removeIncludeUrlAt.
boolean	removeSpecific(String vSpecific) Method removeSpecific.
String	removeSpecificAt(int index) Method removeSpecificAt.
void	setExcludeRange(ExcludeRange[] vExcludeRangeArray)
void	setExcludeRange(int index, ExcludeRange vExcludeRange)
void	setExcludeRange(List<ExcludeRange> vExcludeRangeList) Sets the value of '_excludeRangeList' by copying the given Vector.
void	setExcludeRangeCollection(List<ExcludeRange> excludeRangeList) Deprecated.
void	setFilter(Filter filter) Sets the value of field 'filter'.
void	setIncludeRange(IncludeRange[] vIncludeRangeArray)
void	setIncludeRange(int index, IncludeRange vIncludeRange)
void	setIncludeRange(List<IncludeRange> vIncludeRangeList) Sets the value of '_includeRangeList' by copying the given Vector.
void	setIncludeRangeCollection(List<IncludeRange> includeRangeList) Deprecated.
void	setIncludeUrl(int index, String vIncludeUrl)
void	setIncludeUrl(List<String> vIncludeUrlList) Sets the value of '_includeUrlList' by copying the given Vector.
void	setIncludeUrl(String[] vIncludeUrlArray)
void	setIncludeUrlCollection(List<String> includeUrlList) Deprecated.
void	setName(String name) Sets the value of field 'name'.
void	setSpecific(int index, String vSpecific)
void	setSpecific(List<String> vSpecificList) Sets the value of '_specificList' by copying the given Vector.
void	setSpecific(String[] vSpecificArray)
void	setSpecificCollection(List<String> specificList) Deprecated.
static Package	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

Package

public Package()

Method Detail

addExcludeRange

public void addExcludeRange(ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException

Parameters:

vExcludeRange -

Throws:

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

addExcludeRange

public void addExcludeRange(int index,
                            ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException

Parameters:

index -

vExcludeRange -

Throws:

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

addIncludeRange

public void addIncludeRange(IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException

Parameters:

vIncludeRange -

Throws:

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

addIncludeRange

public void addIncludeRange(int index,
                            IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeRange -

Throws:

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

addIncludeUrl

public void addIncludeUrl(String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

vIncludeUrl -

Throws:

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

addIncludeUrl

public void addIncludeUrl(int index,
                          String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vIncludeUrl -

Throws:

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

addSpecific

public void addSpecific(String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

vSpecific -

Throws:

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

addSpecific

public void addSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

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

enumerateExcludeRange

public Enumeration<ExcludeRange> enumerateExcludeRange()

Method enumerateExcludeRange.

Returns:

an Enumeration over all possible elements of this collection

enumerateIncludeRange

public Enumeration<IncludeRange> enumerateIncludeRange()

Method enumerateIncludeRange.

Returns:

an Enumeration over all possible elements of this collection

enumerateIncludeUrl

public Enumeration<String> enumerateIncludeUrl()

Method enumerateIncludeUrl.

Returns:

an Enumeration over all possible elements of this collection

enumerateSpecific

public Enumeration<String> enumerateSpecific()

Method enumerateSpecific.

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.

getExcludeRange

public ExcludeRange getExcludeRange(int index)
                             throws IndexOutOfBoundsException

Method getExcludeRange.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.map.adapter.ExcludeRange at the given index

Throws:

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

getExcludeRange

public ExcludeRange[] getExcludeRange()

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

getExcludeRangeCollection

public List<ExcludeRange> getExcludeRangeCollection()

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

Returns:

a reference to the Vector backing this class

getExcludeRangeCount

public int getExcludeRangeCount()

Method getExcludeRangeCount.

Returns:

the size of this collection

getFilter

public Filter getFilter()

Returns the value of field 'filter'. The field 'filter' has the following description: A rule which addresses belonging to this package must pass. This package is applied only to addresses that pass this filter.

Returns:

the value of field 'Filter'.

getIncludeRange

public IncludeRange getIncludeRange(int index)
                             throws IndexOutOfBoundsException

Method getIncludeRange.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.map.adapter.IncludeRange at the given index

Throws:

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

getIncludeRange

public IncludeRange[] getIncludeRange()

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

getIncludeRangeCollection

public List<IncludeRange> getIncludeRangeCollection()

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

Returns:

a reference to the Vector backing this class

getIncludeRangeCount

public int getIncludeRangeCount()

Method getIncludeRangeCount.

Returns:

the size of this collection

getIncludeUrl

public String getIncludeUrl(int index)
                     throws IndexOutOfBoundsException

Method getIncludeUrl.

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

getIncludeUrl

public String[] getIncludeUrl()

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

getIncludeUrlCollection

public List<String> getIncludeUrlCollection()

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

Returns:

a reference to the Vector backing this class

getIncludeUrlCount

public int getIncludeUrlCount()

Method getIncludeUrlCount.

Returns:

the size of this collection

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: Name or identifier for this package.

Returns:

the value of field 'Name'.

getSpecific

public String getSpecific(int index)
                   throws IndexOutOfBoundsException

Method getSpecific.

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

getSpecific

public String[] getSpecific()

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

getSpecificCollection

public List<String> getSpecificCollection()

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

Returns:

a reference to the Vector backing this class

getSpecificCount

public int getSpecificCount()

Method getSpecificCount.

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

iterateExcludeRange

public Iterator<ExcludeRange> iterateExcludeRange()

Method iterateExcludeRange.

Returns:

an Iterator over all possible elements in this collection

iterateIncludeRange

public Iterator<IncludeRange> iterateIncludeRange()

Method iterateIncludeRange.

Returns:

an Iterator over all possible elements in this collection

iterateIncludeUrl

public Iterator<String> iterateIncludeUrl()

Method iterateIncludeUrl.

Returns:

an Iterator over all possible elements in this collection

iterateSpecific

public Iterator<String> iterateSpecific()

Method iterateSpecific.

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

removeAllExcludeRange

public void removeAllExcludeRange()

removeAllIncludeRange

public void removeAllIncludeRange()

removeAllIncludeUrl

public void removeAllIncludeUrl()

removeAllSpecific

public void removeAllSpecific()

removeExcludeRange

public boolean removeExcludeRange(ExcludeRange vExcludeRange)

Method removeExcludeRange.

Parameters:

vExcludeRange -

Returns:

true if the object was removed from the collection.

removeExcludeRangeAt

public ExcludeRange removeExcludeRangeAt(int index)

Method removeExcludeRangeAt.

Parameters:

index -

Returns:

the element removed from the collection

removeIncludeRange

public boolean removeIncludeRange(IncludeRange vIncludeRange)

Method removeIncludeRange.

Parameters:

vIncludeRange -

Returns:

true if the object was removed from the collection.

removeIncludeRangeAt

public IncludeRange removeIncludeRangeAt(int index)

Method removeIncludeRangeAt.

Parameters:

index -

Returns:

the element removed from the collection

removeIncludeUrl

public boolean removeIncludeUrl(String vIncludeUrl)

Method removeIncludeUrl.

Parameters:

vIncludeUrl -

Returns:

true if the object was removed from the collection.

removeIncludeUrlAt

public String removeIncludeUrlAt(int index)

Method removeIncludeUrlAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSpecific

public boolean removeSpecific(String vSpecific)

Method removeSpecific.

Parameters:

vSpecific -

Returns:

true if the object was removed from the collection.

removeSpecificAt

public String removeSpecificAt(int index)

Method removeSpecificAt.

Parameters:

index -

Returns:

the element removed from the collection

setExcludeRange

public void setExcludeRange(int index,
                            ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException

Parameters:

index -

vExcludeRange -

Throws:

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

setExcludeRange

public void setExcludeRange(ExcludeRange[] vExcludeRangeArray)

Parameters:

vExcludeRangeArray -

setExcludeRange

public void setExcludeRange(List<ExcludeRange> vExcludeRangeList)

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

Parameters:

vExcludeRangeList - the Vector to copy.

setExcludeRangeCollection

public void setExcludeRangeCollection(List<ExcludeRange> excludeRangeList)

Deprecated.

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

Parameters:

excludeRangeList - the Vector to set.

setFilter

public void setFilter(Filter filter)

Sets the value of field 'filter'. The field 'filter' has the following description: A rule which addresses belonging to this package must pass. This package is applied only to addresses that pass this filter.

Parameters:

filter - the value of field 'filter'.

setIncludeRange

public void setIncludeRange(int index,
                            IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeRange -

Throws:

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

setIncludeRange

public void setIncludeRange(IncludeRange[] vIncludeRangeArray)

Parameters:

vIncludeRangeArray -

setIncludeRange

public void setIncludeRange(List<IncludeRange> vIncludeRangeList)

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

Parameters:

vIncludeRangeList - the Vector to copy.

setIncludeRangeCollection

public void setIncludeRangeCollection(List<IncludeRange> includeRangeList)

Deprecated.

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

Parameters:

includeRangeList - the Vector to set.

setIncludeUrl

public void setIncludeUrl(int index,
                          String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vIncludeUrl -

Throws:

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

setIncludeUrl

public void setIncludeUrl(String[] vIncludeUrlArray)

Parameters:

vIncludeUrlArray -

setIncludeUrl

public void setIncludeUrl(List<String> vIncludeUrlList)

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

Parameters:

vIncludeUrlList - the Vector to copy.

setIncludeUrlCollection

public void setIncludeUrlCollection(List<String> includeUrlList)

Deprecated.

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

Parameters:

includeUrlList - the Vector to set.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: Name or identifier for this package.

Parameters:

name - the value of field 'name'.

setSpecific

public void setSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

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

setSpecific

public void setSpecific(String[] vSpecificArray)

Parameters:

vSpecificArray -

setSpecific

public void setSpecific(List<String> vSpecificList)

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

Parameters:

vSpecificList - the Vector to copy.

setSpecificCollection

public void setSpecificCollection(List<String> specificList)

Deprecated.

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

Parameters:

specificList - the Vector to set.

unmarshal

public static Package 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.map.adapter.Package

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