org.opennms.netmgt.config.syslogd

Class HideMessage

java.lang.Object

org.opennms.netmgt.config.syslogd.HideMessage

All Implemented Interfaces:

Serializable

public class HideMessage
extends Object
implements Serializable

Class HideMessage.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HideMessage()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHideMatch(HideMatch vHideMatch)
void	addHideMatch(int index, HideMatch vHideMatch)
Enumeration<HideMatch>	enumerateHideMatch() Method enumerateHideMatch.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
HideMatch[]	getHideMatch() Method getHideMatch.Returns the contents of the collection in an Array.
HideMatch	getHideMatch(int index) Method getHideMatch.
List<HideMatch>	getHideMatchCollection() Method getHideMatchCollection.Returns a reference to '_hideMatchList'.
int	getHideMatchCount() Method getHideMatchCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<HideMatch>	iterateHideMatch() Method iterateHideMatch.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllHideMatch()
boolean	removeHideMatch(HideMatch vHideMatch) Method removeHideMatch.
HideMatch	removeHideMatchAt(int index) Method removeHideMatchAt.
void	setHideMatch(HideMatch[] vHideMatchArray)
void	setHideMatch(int index, HideMatch vHideMatch)
void	setHideMatch(List<HideMatch> vHideMatchList) Sets the value of '_hideMatchList' by copying the given Vector.
void	setHideMatchCollection(List<HideMatch> hideMatchList) Deprecated.
static HideMessage	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

HideMessage

public HideMessage()

Method Detail

addHideMatch

public void addHideMatch(HideMatch vHideMatch)
                  throws IndexOutOfBoundsException

Parameters:

vHideMatch -

Throws:

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

addHideMatch

public void addHideMatch(int index,
                HideMatch vHideMatch)
                  throws IndexOutOfBoundsException

Parameters:

index -

vHideMatch -

Throws:

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

enumerateHideMatch

public Enumeration<HideMatch> enumerateHideMatch()

Method enumerateHideMatch.

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.

getHideMatch

public HideMatch getHideMatch(int index)
                       throws IndexOutOfBoundsException

Method getHideMatch.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.syslogd.HideMatch at the given inde

Throws:

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

getHideMatch

public HideMatch[] getHideMatch()

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

getHideMatchCollection

public List<HideMatch> getHideMatchCollection()

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

Returns:

a reference to the Vector backing this class

getHideMatchCount

public int getHideMatchCount()

Method getHideMatchCount.

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

iterateHideMatch

public Iterator<HideMatch> iterateHideMatch()

Method iterateHideMatch.

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

removeAllHideMatch

public void removeAllHideMatch()

removeHideMatch

public boolean removeHideMatch(HideMatch vHideMatch)

Method removeHideMatch.

Parameters:

vHideMatch -

Returns:

true if the object was removed from the collection.

removeHideMatchAt

public HideMatch removeHideMatchAt(int index)

Method removeHideMatchAt.

Parameters:

index -

Returns:

the element removed from the collection

setHideMatch

public void setHideMatch(int index,
                HideMatch vHideMatch)
                  throws IndexOutOfBoundsException

Parameters:

index -

vHideMatch -

Throws:

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

setHideMatch

public void setHideMatch(HideMatch[] vHideMatchArray)

Parameters:

vHideMatchArray -

setHideMatch

public void setHideMatch(List<HideMatch> vHideMatchList)

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

Parameters:

vHideMatchList - the Vector to copy.

setHideMatchCollection

public void setHideMatchCollection(List<HideMatch> hideMatchList)

Deprecated.

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

Parameters:

hideMatchList - the Vector to set.

unmarshal

public static HideMessage 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.HideMessage

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