org.opennms.netmgt.config.pagesequence

Class SessionVariable

java.lang.Object

org.opennms.netmgt.config.pagesequence.SessionVariable

All Implemented Interfaces:

Serializable

public class SessionVariable
extends Object
implements Serializable

Assign the value of a regex match group to a session variable with a user-defined name. The match group is identified by number and must be zero or greater.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SessionVariable()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteMatchGroup()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
int	getMatchGroup() Returns the value of field 'matchGroup'.
String	getName() Returns the value of field 'name'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasMatchGroup() Method hasMatchGroup.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setMatchGroup(int matchGroup) Sets the value of field 'matchGroup'.
void	setName(String name) Sets the value of field 'name'.
static SessionVariable	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

SessionVariable

public SessionVariable()

Method Detail

deleteMatchGroup

public void deleteMatchGroup()

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.

getMatchGroup

public int getMatchGroup()

Returns the value of field 'matchGroup'.

Returns:

the value of field 'MatchGroup'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

hasMatchGroup

public boolean hasMatchGroup()

Method hasMatchGroup.

Returns:

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

setMatchGroup

public void setMatchGroup(int matchGroup)

Sets the value of field 'matchGroup'.

Parameters:

matchGroup - the value of field 'matchGroup'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

unmarshal

public static SessionVariable 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.pagesequence.SessionVariable

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