TriggerEvent (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.TriggerEvent

All Implemented Interfaces:

Serializable
```
public class TriggerEvent
extends Object
implements Serializable
```
A class representing an event. Specific event types have been defined in reference to SCXML. NOTE: Instances are Serializable as long as the associated payload, if any, is Serializable.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CALL_EVENT` `CALL_EVENT`.
`static int`	`CANCEL_EVENT` `CANCEL_EVENT`.
`static int`	`CHANGE_EVENT` `CHANGE_EVENT`.
`static String`	`ERROR_COMMUNICATION` The predefined SCXML 'error.communication' Event name Indicates that an error has occurred while trying to communicate with an external entity.
`static int`	`ERROR_EVENT` `ERROR_EVENT`.
`static String`	`ERROR_EXECUTION` The predefined SCXML 'error.execution' Event name Indicates that an error internal to the execution of the document has occurred, such as one arising from expression evaluation.
`static String`	`ERROR_PLATFORM` The predefined SCXML 'error.platform' Event name Indicates that a platform- or application-specific error has occurred.
`static int`	`SIGNAL_EVENT` `SIGNAL_EVENT`.
`static int`	`TIME_EVENT` `TIME_EVENT`.

Constructor Summary

Constructors
Constructor and Description
`TriggerEvent(String name, int type)` Constructor.
`TriggerEvent(String name, int type, Object payload)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Define an equals operator for TriggerEvent.
`String`	`getName()`
`Object`	`getPayload()`
`int`	`getType()`
`int`	`hashCode()` Returns the hash code for this TriggerEvent object.
`String`	`toString()` Returns a string representation of this TriggerEvent object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CALL_EVENT
```
public static final int CALL_EVENT
```
    CALL_EVENT.
    
    See Also:
    Constant Field Values
  - CHANGE_EVENT
```
public static final int CHANGE_EVENT
```
    CHANGE_EVENT.
    
    See Also:
    Constant Field Values
  - SIGNAL_EVENT
```
public static final int SIGNAL_EVENT
```
    SIGNAL_EVENT.
    
    See Also:
    Constant Field Values
  - TIME_EVENT
```
public static final int TIME_EVENT
```
    TIME_EVENT.
    
    See Also:
    Constant Field Values
  - ERROR_EVENT
```
public static final int ERROR_EVENT
```
    ERROR_EVENT.
    
    See Also:
    Constant Field Values
  - CANCEL_EVENT
```
public static final int CANCEL_EVENT
```
    CANCEL_EVENT.
    
    See Also:
    Constant Field Values
  - ERROR_EXECUTION
```
public static final String ERROR_EXECUTION
```
    The predefined SCXML 'error.execution' Event name
    Indicates that an error internal to the execution of the document has occurred, such as one arising from expression evaluation.
    
    See Also:
    Constant Field Values
  - ERROR_COMMUNICATION
```
public static final String ERROR_COMMUNICATION
```
    The predefined SCXML 'error.communication' Event name
    Indicates that an error has occurred while trying to communicate with an external entity.
    
    See Also:
    Constant Field Values
  - ERROR_PLATFORM
```
public static final String ERROR_PLATFORM
```
    The predefined SCXML 'error.platform' Event name
    Indicates that a platform- or application-specific error has occurred.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TriggerEvent
```
public TriggerEvent(String name,
            int type,
            Object payload)
```
    Constructor.
    
    Parameters:
    name - The event name
    type - The event type
    payload - The event payload, must be Serializable
  - TriggerEvent
```
public TriggerEvent(String name,
            int type)
```
    Constructor.
    
    Parameters:
    name - The event name
    type - The event type
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    Returns the name.
  - getPayload
```
public Object getPayload()
```
    Returns:
    Returns the payload.
  - getType
```
public int getType()
```
    Returns:
    Returns the type.
  - equals
```
public boolean equals(Object obj)
```
    Define an equals operator for TriggerEvent.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    Object.equals(java.lang.Object)
  - toString
```
public String toString()
```
    Returns a string representation of this TriggerEvent object.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this TriggerEvent object.
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    Object.hashCode()

Class TriggerEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CALL_EVENT

CHANGE_EVENT

SIGNAL_EVENT

TIME_EVENT

ERROR_EVENT

CANCEL_EVENT

ERROR_EXECUTION

ERROR_COMMUNICATION

ERROR_PLATFORM

Constructor Detail

TriggerEvent

TriggerEvent

Method Detail

getName

getPayload

getType

equals

toString

hashCode