org.opennms.netmgt.config.httpdatacollection

Class Uris

java.lang.Object

org.opennms.netmgt.config.httpdatacollection.Uris

All Implemented Interfaces:

Serializable

public class Uris
extends Object
implements Serializable

Class Uris.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Uris()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUri(int index, Uri vUri)
void	addUri(Uri vUri)
Enumeration<Uri>	enumerateUri() Method enumerateUri.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Uri[]	getUri() Method getUri.Returns the contents of the collection in an Array.
Uri	getUri(int index) Method getUri.
List<Uri>	getUriCollection() Method getUriCollection.Returns a reference to '_uriList'.
int	getUriCount() Method getUriCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Uri>	iterateUri() Method iterateUri.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUri()
boolean	removeUri(Uri vUri) Method removeUri.
Uri	removeUriAt(int index) Method removeUriAt.
void	setUri(int index, Uri vUri)
void	setUri(List<Uri> vUriList) Sets the value of '_uriList' by copying the given Vector.
void	setUri(Uri[] vUriArray)
void	setUriCollection(List<Uri> uriList) Deprecated.
static Uris	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

Uris

public Uris()

Method Detail

addUri

public void addUri(Uri vUri)
            throws IndexOutOfBoundsException

Parameters:

vUri -

Throws:

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

addUri

public void addUri(int index,
          Uri vUri)
            throws IndexOutOfBoundsException

Parameters:

index -

vUri -

Throws:

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

enumerateUri

public Enumeration<Uri> enumerateUri()

Method enumerateUri.

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.

getUri

public Uri getUri(int index)
           throws IndexOutOfBoundsException

Method getUri.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.httpdatacollection.Uri at the given index

Throws:

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

getUri

public Uri[] getUri()

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

getUriCollection

public List<Uri> getUriCollection()

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

Returns:

a reference to the Vector backing this class

getUriCount

public int getUriCount()

Method getUriCount.

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

iterateUri

public Iterator<Uri> iterateUri()

Method iterateUri.

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

removeAllUri

public void removeAllUri()

removeUri

public boolean removeUri(Uri vUri)

Method removeUri.

Parameters:

vUri -

Returns:

true if the object was removed from the collection.

removeUriAt

public Uri removeUriAt(int index)

Method removeUriAt.

Parameters:

index -

Returns:

the element removed from the collection

setUri

public void setUri(int index,
          Uri vUri)
            throws IndexOutOfBoundsException

Parameters:

index -

vUri -

Throws:

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

setUri

public void setUri(Uri[] vUriArray)

Parameters:

vUriArray -

setUri

public void setUri(List<Uri> vUriList)

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

Parameters:

vUriList - the Vector to copy.

setUriCollection

public void setUriCollection(List<Uri> uriList)

Deprecated.

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

Parameters:

uriList - the Vector to set.

unmarshal

public static Uris 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.httpdatacollection.Uris

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