org.opennms.netmgt.config.service

Class ServiceConfiguration

java.lang.Object

org.opennms.netmgt.config.service.ServiceConfiguration

All Implemented Interfaces:

Serializable

public class ServiceConfiguration
extends Object
implements Serializable

Top-level element for the service-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceConfiguration()
ServiceConfiguration(List<Service> serviceList)

Method Summary

Modifier and Type	Method and Description
void	addService(int index, Service vService)
void	addService(Service vService)
Enumeration<Service>	enumerateService() Method enumerateService.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Service[]	getService() Method getService.Returns the contents of the collection in an Array.
Service	getService(int index) Method getService.
List<Service>	getServiceCollection() Method getServiceCollection.Returns a reference to '_serviceList'.
int	getServiceCount() Method getServiceCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
Iterator<Service>	iterateService() Method iterateService.
void	removeAllService()
boolean	removeService(Service vService) Method removeService.
Service	removeServiceAt(int index) Method removeServiceAt.
void	setService(int index, Service vService)
void	setService(List<Service> vServiceList) Sets the value of '_serviceList' by copying the given Vector.
void	setService(Service[] vServiceArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceConfiguration

public ServiceConfiguration()

ServiceConfiguration

public ServiceConfiguration(List<Service> serviceList)

Method Detail

addService

public void addService(Service vService)
                throws IndexOutOfBoundsException

Parameters:

vService -

Throws:

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

addService

public void addService(int index,
                       Service vService)
                throws IndexOutOfBoundsException

Parameters:

index -

vService -

Throws:

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

enumerateService

public Enumeration<Service> enumerateService()

Method enumerateService.

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.

getService

public Service getService(int index)
                   throws IndexOutOfBoundsException

Method getService.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.service.Service at the given index

Throws:

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

getService

public Service[] getService()

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

getServiceCollection

public List<Service> getServiceCollection()

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

Returns:

a reference to the Vector backing this class

getServiceCount

public int getServiceCount()

Method getServiceCount.

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.

iterateService

public Iterator<Service> iterateService()

Method iterateService.

Returns:

an Iterator over all possible elements in this collection

removeAllService

public void removeAllService()

removeService

public boolean removeService(Service vService)

Method removeService.

Parameters:

vService -

Returns:

true if the object was removed from the collection.

removeServiceAt

public Service removeServiceAt(int index)

Method removeServiceAt.

Parameters:

index -

Returns:

the element removed from the collection

setService

public void setService(int index,
                       Service vService)
                throws IndexOutOfBoundsException

Parameters:

index -

vService -

Throws:

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

setService

public void setService(Service[] vServiceArray)

Parameters:

vServiceArray -

setService

public void setService(List<Service> vServiceList)

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

Parameters:

vServiceList - the Vector to copy.