org.opennms.netmgt.config.syslogd
Class ParameterAssignment

java.lang.Object
  org.opennms.netmgt.config.syslogd.ParameterAssignment

All Implemented Interfaces:

Serializable

public class ParameterAssignment
extends Object
implements Serializable

For regex matches, assign the value of a matching group to a named event parameter

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ParameterAssignment()

Method Summary

void	deleteMatchingGroup()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
int	getMatchingGroup() Returns the value of field 'matchingGroup'.
String	getParameterName() Returns the value of field 'parameterName'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasMatchingGroup() Method hasMatchingGroup.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setMatchingGroup(int matchingGroup) Sets the value of field 'matchingGroup'.
void	setParameterName(String parameterName) Sets the value of field 'parameterName'.
static ParameterAssignment	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

ParameterAssignment

public ParameterAssignment()

Method Detail

deleteMatchingGroup

public void deleteMatchingGroup()

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.

getMatchingGroup

public int getMatchingGroup()

Returns the value of field 'matchingGroup'. The field 'matchingGroup' has the following description: The number of the matching group from the regex whose value will be assigned. Group 0 always refers to the entire string matched by the expression. If the referenced group does not exist, the empty string will be assigned.

Returns:

the value of field 'MatchingGroup'.

getParameterName

public String getParameterName()

Returns the value of field 'parameterName'. The field 'parameterName' has the following description: The name of the event parameter to which the named matching group's value will be assigned

Returns:

the value of field 'ParameterName'.

hasMatchingGroup

public boolean hasMatchingGroup()

Method hasMatchingGroup.

Returns:

true if at least one MatchingGroup 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.

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

setMatchingGroup

public void setMatchingGroup(int matchingGroup)

Sets the value of field 'matchingGroup'. The field 'matchingGroup' has the following description: The number of the matching group from the regex whose value will be assigned. Group 0 always refers to the entire string matched by the expression. If the referenced group does not exist, the empty string will be assigned.

Parameters:

matchingGroup - the value of field 'matchingGroup'.

setParameterName

public void setParameterName(String parameterName)

Sets the value of field 'parameterName'. The field 'parameterName' has the following description: The name of the event parameter to which the named matching group's value will be assigned

Parameters:

parameterName - the value of field 'parameterName'.

unmarshal

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

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