net.lenni0451.commandlib.contexts

Class ExecutionContext<E>

java.lang.Object

net.lenni0451.commandlib.contexts.ExecutionContext<E>

Type Parameters:

E - The type of the executor

public class ExecutionContext<E>
extends java.lang.Object

A context which is used to store information about the execution process.

Constructor Summary

Constructors

Constructor and Description
ExecutionContext(ArgumentComparator argumentComparator, E executor, boolean isExecution)

Method Summary

Modifier and Type	Method and Description
void	addArgument(java.lang.String name, java.lang.Object value) Add a parsed argument.
<T> T	getArgument(java.lang.String name) Get a parsed argument by its name.
ArgumentComparator	getArgumentComparator()
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
E	getExecutor()
boolean	isExecution()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContext

public ExecutionContext(ArgumentComparator argumentComparator,
                        E executor,
                        boolean isExecution)

Method Detail

getArgumentComparator

public ArgumentComparator getArgumentComparator()

Returns:

The used argument comparator

getExecutor

public E getExecutor()

Returns:

The executor executing the command

getArguments

public java.util.Map<java.lang.String,java.lang.Object> getArguments()

Returns:

All parsed arguments

getArgument

@Nonnull
public <T> T getArgument(java.lang.String name)

Get a parsed argument by its name.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

Returns:

The parsed argument

Throws:

java.lang.IllegalArgumentException - If the argument does not exist

addArgument

public void addArgument(java.lang.String name,
                        java.lang.Object value)

Add a parsed argument.

Parameters:

name - The name of the argument

value - The value of the argument

isExecution

public boolean isExecution()

Returns:

If the context is used for execution