Package com.gurock.smartinspect.connections.options

Class OptionsParserEvent

java.lang.Object

java.util.EventObject

com.gurock.smartinspect.connections.options.OptionsParserEvent

All Implemented Interfaces:

Serializable

public class OptionsParserEvent
extends EventObject

This class is used by the OptionsParser class to inform interested parties about found options. It offers the necessary properties to retrieve the found options in the event handlers.

This class is used by the OptionsParser.parse(java.lang.String, java.lang.String, com.gurock.smartinspect.connections.options.OptionsParserListener) method.

This class is fully threadsafe.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
OptionsParserEvent(Object source, String protocol, String key, String value)	Creates and initializes a new OptionsParserEventArgs instance.

Method Summary

Modifier and Type	Method	Description
String	getKey()	This method returns the key of the option which has just been found by an OptionsParser object.
String	getProtocol()	This method returns the protocol of the option which has just been found by a OptionsParser object.
String	getValue()	This method returns the value of the option which has just been found by a OptionsParser object.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OptionsParserEvent

public OptionsParserEvent(Object source,
                          String protocol,
                          String key,
                          String value)

Creates and initializes a new OptionsParserEventArgs instance.

Parameters:

source - The object which caused the event

protocol - The protocol of the new option

key - The key of the new option

value - The value of the new option

Method Detail

getProtocol

public String getProtocol()

This method returns the protocol of the option which has just been found by a OptionsParser object.

Returns:

The protocol of the found option

getKey

public String getKey()

This method returns the key of the option which has just been found by an OptionsParser object.

Returns:

The key of the found option.

getValue

public String getValue()

This method returns the value of the option which has just been found by a OptionsParser object.

Returns:

The value of the found option.