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

Class CommandFiredPayload

java.lang.Object

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

com.j3d.engine.react.events.payloads.CommandFiredPayload

public class CommandFiredPayload
extends EventPayload<Command>

Event payload for when any command has been fired.

This event stores:

• The Command instance of the command being fired (the emitter of the event)
• The Invoker which describes the invocation of the command
• The aliasUsed to invoke the command
• The argsCopy[] to view the arguments that got passed into the command
• The taggedArgsCopy to view the tagged arguments that got passed into the command

Author:

Lehlogonolo Poole

See Also:

• Command
• Commands
• EventType.COMMAND_FIRED
• Invoker
• CommandParser

Field Summary

Fields

Modifier and Type	Field	Description
private final String	aliasUsed
private final Object[]	argsCopy
private final Invoker	invoker
private final ArrayList<TaggedArgValue<?>>	taggedArgsCopy

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

emitter

Constructor Summary

Constructors

Constructor	Description
CommandFiredPayload(Command cmd, Invoker i, String alias, Object[] args, ArrayList<TaggedArgValue<?>> taggedArgs)

Method Summary

Modifier and Type	Method	Description
String	getAliasUsed()
Object[]	getArgsCopy()
Command	getCommand()
Invoker	getInvoker()
ArrayList<TaggedArgValue<?>>	getTaggedArgsCopy()

Methods inherited from class java.lang.Object

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

Field Details

invoker

private final Invoker invoker

aliasUsed

private final String aliasUsed

argsCopy

private final Object[] argsCopy

taggedArgsCopy

private final ArrayList<TaggedArgValue<?>> taggedArgsCopy

Constructor Details

CommandFiredPayload

public CommandFiredPayload(Command cmd,
 Invoker i,
 String alias,
 Object[] args,
 ArrayList<TaggedArgValue<?>> taggedArgs)

Method Details

getCommand

public Command getCommand()

getInvoker

public Invoker getInvoker()

getTaggedArgsCopy

public ArrayList<TaggedArgValue<?>> getTaggedArgsCopy()

getArgsCopy

public Object[] getArgsCopy()

getAliasUsed

public String getAliasUsed()