Package com.j3d.engine.react.events.payloads

Class StatefulCommandCompletedPayload

java.lang.Object

com.j3d.engine.react.events.EventPayload<SemiStatefulCommand>

com.j3d.engine.react.events.payloads.StatefulCommandCompletedPayload

public class StatefulCommandCompletedPayload
extends EventPayload<SemiStatefulCommand>

Event payload for when a StatefulCommand has completed its execution.

This stores the StatefulCommand that completed and the StatefulCommandCompletedPayload.CompletionType indicating how it completed (e.g., by user pressing Enter or by being cancelled).

Author:

Lehlogonolo Poole

See Also:

• EventType.STATEFUL_COMMAND_COMPLETED
• StatefulCommand
• StatefulCommandCompletedPayload.CompletionType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StatefulCommandCompletedPayload.CompletionType	Represents the manner in which a StatefulCommand completed its execution. however if the given only implements as high as SemiStatefulCommand it will always be StatefulCommandCompletedPayload.CompletionType.ENTER

Field Summary

Fields

Modifier and Type	Field	Description
private final StatefulCommandCompletedPayload.CompletionType	completionType

Fields inherited from class com.j3d.engine.react.events.EventPayload

emitter

Constructor Summary

Constructors

Constructor	Description
StatefulCommandCompletedPayload(SemiStatefulCommand e, boolean userHitEnter)

Method Summary

Modifier and Type	Method	Description
StatefulCommandCompletedPayload.CompletionType	getCompletionType()

Methods inherited from class java.lang.Object

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

Field Details

completionType

private final StatefulCommandCompletedPayload.CompletionType completionType

Constructor Details

StatefulCommandCompletedPayload

public StatefulCommandCompletedPayload(SemiStatefulCommand e,
 boolean userHitEnter)

Method Details

getCompletionType

public StatefulCommandCompletedPayload.CompletionType getCompletionType()