org.opennms.netmgt.config.syslogd

Class Match

java.lang.Object

org.opennms.netmgt.config.syslogd.Match

All Implemented Interfaces:

Serializable

public class Match
extends Object
implements Serializable

String against which to match the message body; interpreted as a substring or a regular expression according to the value of the "type" attribute

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Match()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDefaultParameterMapping()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getDefaultParameterMapping() Returns the value of field 'defaultParameterMapping'.
String	getExpression() Returns the value of field 'expression'.
String	getType() Returns the value of field 'type'.
boolean	hasDefaultParameterMapping() Method hasDefaultParameterMapping.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isDefaultParameterMapping() Returns the value of field 'defaultParameterMapping'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDefaultParameterMapping(boolean defaultParameterMapping) Sets the value of field 'defaultParameterMapping'.
void	setExpression(String expression) Sets the value of field 'expression'.
void	setType(String type) Sets the value of field 'type'.
static Match	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

Match

public Match()

Method Detail

deleteDefaultParameterMapping

public void deleteDefaultParameterMapping()

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.

getDefaultParameterMapping

public boolean getDefaultParameterMapping()

Returns the value of field 'defaultParameterMapping'. The field 'defaultParameterMapping' has the following description: Whether to do the default mappings of matching-groups to event parameters (group 1 -> group1, etc.) if this is a regex match.

Returns:

the value of field 'DefaultParameterMapping'.

getExpression

public String getExpression()

Returns the value of field 'expression'. The field 'expression' has the following description: The match expression

Returns:

the value of field 'Expression'.

getType

public String getType()

Returns the value of field 'type'. The field 'type' has the following description: Whether to interpret this match string as a simple substring or as a regular expression

Returns:

the value of field 'Type'.

hasDefaultParameterMapping

public boolean hasDefaultParameterMapping()

Method hasDefaultParameterMapping.

Returns:

true if at least one DefaultParameterMapping has been added

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.

isDefaultParameterMapping

public boolean isDefaultParameterMapping()

Returns the value of field 'defaultParameterMapping'. The field 'defaultParameterMapping' has the following description: Whether to do the default mappings of matching-groups to event parameters (group 1 -> group1, etc.) if this is a regex match.

Returns:

the value of field 'DefaultParameterMapping'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

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

setDefaultParameterMapping

public void setDefaultParameterMapping(boolean defaultParameterMapping)

Sets the value of field 'defaultParameterMapping'. The field 'defaultParameterMapping' has the following description: Whether to do the default mappings of matching-groups to event parameters (group 1 -> group1, etc.) if this is a regex match.

Parameters:

defaultParameterMapping - the value of field 'defaultParameterMapping'.

setExpression

public void setExpression(String expression)

Sets the value of field 'expression'. The field 'expression' has the following description: The match expression

Parameters:

expression - the value of field 'expression'.

setType

public void setType(String type)

Sets the value of field 'type'. The field 'type' has the following description: Whether to interpret this match string as a simple substring or as a regular expression

Parameters:

type - the value of field 'type'.

unmarshal

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

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