org.sape.carbon.core.component.event
Class ComponentEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--org.sape.carbon.core.component.event.ComponentEvent

All Implemented Interfaces:

Serializable

public class ComponentEvent

extends EventObject

Sent to signify an event on the sending component.

Copyright 2003 Sapient

Since:

carbon 2.0

Version:

$Revision: 1.4 $($Author: dvoet $ / $Date: 2003/05/05 21:21:12 $)

Author:

Greg Hinkle, March 2003

See Also:

Serialized Form

Field Summary

protected String	message The message for the event.
protected String	name The name of the event.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ComponentEvent(Object source, String eventName, String eventMessage)
Constructs a new component event.

Method Summary

String	getMessage() Retrieves the message for the event.
String	getName() Retrieves the name of the event.

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

Field Detail

name

protected String name

The name of the event.

message

protected String message

The message for the event.

Constructor Detail

ComponentEvent

public ComponentEvent(Object source,
                      String eventName,
                      String eventMessage)

Constructs a new component event. Used to send messages to those who may handle component events. Events are sent when a component has a configured decorator implementing the EventManager interface.

Parameters:

source - The source object for the event.

eventName - the name of the event.

eventMessage - a description of the event.

Method Detail

getName

public String getName()

Retrieves the name of the event.

Returns:

the name of the event.

getMessage

public String getMessage()

Retrieves the message for the event.

Returns:

the message for the event.