org.opennms.netmgt.config.attrsummary
Class Summary

java.lang.Object
  org.opennms.netmgt.config.attrsummary.Summary

All Implemented Interfaces:

Serializable

public class Summary
extends Object
implements Serializable

Class Summary.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Summary()

Method Summary

void	addResource(int index, Resource vResource)
void	addResource(Resource vResource)
Enumeration<Resource>	enumerateResource() Method enumerateResource.
Resource[]	getResource() Method getResource.Returns the contents of the collection in an Array.
Resource	getResource(int index) Method getResource.
List<Resource>	getResourceCollection() Method getResourceCollection.Returns a reference to '_resourceList'.
int	getResourceCount() Method getResourceCount.
boolean	isValid() Method isValid.
Iterator<Resource>	iterateResource() Method iterateResource.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllResource()
boolean	removeResource(Resource vResource) Method removeResource.
Resource	removeResourceAt(int index) Method removeResourceAt.
void	setResource(int index, Resource vResource)
void	setResource(List<Resource> vResourceList) Sets the value of '_resourceList' by copying the given Vector.
void	setResource(Resource[] vResourceArray)
void	setResourceCollection(List<Resource> resourceList) Deprecated.
static Summary	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

Summary

public Summary()

Method Detail

addResource

public void addResource(Resource vResource)
                 throws IndexOutOfBoundsException

Parameters:

vResource -

Throws:

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

addResource

public void addResource(int index,
                        Resource vResource)
                 throws IndexOutOfBoundsException

Parameters:

index -

vResource -

Throws:

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

enumerateResource

public Enumeration<Resource> enumerateResource()

Method enumerateResource.

Returns:

an Enumeration over all possible elements of this collection

getResource

public Resource getResource(int index)
                     throws IndexOutOfBoundsException

Method getResource.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.attrsummary.Resource at the given index

Throws:

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

getResource

public Resource[] getResource()

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

getResourceCollection

public List<Resource> getResourceCollection()

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

Returns:

a reference to the Vector backing this class

getResourceCount

public int getResourceCount()

Method getResourceCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateResource

public Iterator<Resource> iterateResource()

Method iterateResource.

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

removeAllResource

public void removeAllResource()

removeResource

public boolean removeResource(Resource vResource)

Method removeResource.

Parameters:

vResource -

Returns:

true if the object was removed from the collection.

removeResourceAt

public Resource removeResourceAt(int index)

Method removeResourceAt.

Parameters:

index -

Returns:

the element removed from the collection

setResource

public void setResource(int index,
                        Resource vResource)
                 throws IndexOutOfBoundsException

Parameters:

index -

vResource -

Throws:

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

setResource

public void setResource(Resource[] vResourceArray)

Parameters:

vResourceArray -

setResource

public void setResource(List<Resource> vResourceList)

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

Parameters:

vResourceList - the Vector to copy.

setResourceCollection

public void setResourceCollection(List<Resource> resourceList)

Deprecated.

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

Parameters:

resourceList - the Vector to set.

unmarshal

public static Summary 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.attrsummary.Summary

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