org.opennms.netmgt.config.syslogd

Class UeiList

java.lang.Object

org.opennms.netmgt.config.syslogd.UeiList

All Implemented Interfaces:

Serializable

public class UeiList
extends Object
implements Serializable

Class UeiList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UeiList()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUeiMatch(int index, UeiMatch vUeiMatch)
void	addUeiMatch(UeiMatch vUeiMatch)
Enumeration<UeiMatch>	enumerateUeiMatch() Method enumerateUeiMatch.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
UeiMatch[]	getUeiMatch() Method getUeiMatch.Returns the contents of the collection in an Array.
UeiMatch	getUeiMatch(int index) Method getUeiMatch.
List<UeiMatch>	getUeiMatchCollection() Method getUeiMatchCollection.Returns a reference to '_ueiMatchList'.
int	getUeiMatchCount() Method getUeiMatchCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<UeiMatch>	iterateUeiMatch() Method iterateUeiMatch.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUeiMatch()
boolean	removeUeiMatch(UeiMatch vUeiMatch) Method removeUeiMatch.
UeiMatch	removeUeiMatchAt(int index) Method removeUeiMatchAt.
void	setUeiMatch(int index, UeiMatch vUeiMatch)
void	setUeiMatch(List<UeiMatch> vUeiMatchList) Sets the value of '_ueiMatchList' by copying the given Vector.
void	setUeiMatch(UeiMatch[] vUeiMatchArray)
void	setUeiMatchCollection(List<UeiMatch> ueiMatchList) Deprecated.
static UeiList	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

UeiList

public UeiList()

Method Detail

addUeiMatch

public void addUeiMatch(UeiMatch vUeiMatch)
                 throws IndexOutOfBoundsException

Parameters:

vUeiMatch -

Throws:

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

addUeiMatch

public void addUeiMatch(int index,
               UeiMatch vUeiMatch)
                 throws IndexOutOfBoundsException

Parameters:

index -

vUeiMatch -

Throws:

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

enumerateUeiMatch

public Enumeration<UeiMatch> enumerateUeiMatch()

Method enumerateUeiMatch.

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.

getUeiMatch

public UeiMatch getUeiMatch(int index)
                     throws IndexOutOfBoundsException

Method getUeiMatch.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.syslogd.UeiMatch at the given index

Throws:

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

getUeiMatch

public UeiMatch[] getUeiMatch()

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

getUeiMatchCollection

public List<UeiMatch> getUeiMatchCollection()

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

Returns:

a reference to the Vector backing this class

getUeiMatchCount

public int getUeiMatchCount()

Method getUeiMatchCount.

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

iterateUeiMatch

public Iterator<UeiMatch> iterateUeiMatch()

Method iterateUeiMatch.

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

removeAllUeiMatch

public void removeAllUeiMatch()

removeUeiMatch

public boolean removeUeiMatch(UeiMatch vUeiMatch)

Method removeUeiMatch.

Parameters:

vUeiMatch -

Returns:

true if the object was removed from the collection.

removeUeiMatchAt

public UeiMatch removeUeiMatchAt(int index)

Method removeUeiMatchAt.

Parameters:

index -

Returns:

the element removed from the collection

setUeiMatch

public void setUeiMatch(int index,
               UeiMatch vUeiMatch)
                 throws IndexOutOfBoundsException

Parameters:

index -

vUeiMatch -

Throws:

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

setUeiMatch

public void setUeiMatch(UeiMatch[] vUeiMatchArray)

Parameters:

vUeiMatchArray -

setUeiMatch

public void setUeiMatch(List<UeiMatch> vUeiMatchList)

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

Parameters:

vUeiMatchList - the Vector to copy.

setUeiMatchCollection

public void setUeiMatchCollection(List<UeiMatch> ueiMatchList)

Deprecated.

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

Parameters:

ueiMatchList - the Vector to set.

unmarshal

public static UeiList 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.syslogd.UeiList

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