Package net.apartium.cocoabeans.commands

Class SimpleCommandProcessingContext

java.lang.Object

net.apartium.cocoabeans.commands.SimpleCommandProcessingContext

All Implemented Interfaces:

CommandProcessingContext

@AvailableSince("0.0.37")
public class SimpleCommandProcessingContext
extends Object
implements CommandProcessingContext

A simple implementation of CommandProcessingContext

Constructor Summary

Constructors

Constructor	Description
SimpleCommandProcessingContext(@NotNull Sender sender, String label, String[] args, int index)	Create a simple command processing context

Method Summary

Modifier and Type	Method	Description
List<String>	args()	Returns the arguments
void	clearReports()	Clear the current report
BadCommandResponse	getReport()	Retrieving the current report
int	index()	Returns the current index
String	label()	Returns the command name
void	report(Object source, @NotNull BadCommandResponse response)	report a problem with command parsing
@NotNull Sender	sender()	Returns the sender
RequirementResult	senderMeetsRequirement(Requirement requirement)	check if sender meets requirement

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleCommandProcessingContext

public SimpleCommandProcessingContext(@NotNull
 @NotNull Sender sender,
 String label,
 String[] args,
 int index)

Create a simple command processing context

Parameters:

sender - sender

label - label (command name)

args - args split by spaces

index - current index

Method Details

sender

@NotNull
public @NotNull Sender sender()

Returns the sender

Specified by:

sender in interface CommandProcessingContext

Returns:

sender

label

public String label()

Returns the command name

Specified by:

label in interface CommandProcessingContext

Returns:

command name

args

public List<String> args()

Returns the arguments

Specified by:

args in interface CommandProcessingContext

Returns:

arguments

index

public int index()

Returns the current index

Specified by:

index in interface CommandProcessingContext

Returns:

current index

senderMeetsRequirement

public RequirementResult senderMeetsRequirement(Requirement requirement)

check if sender meets requirement

Specified by:

senderMeetsRequirement in interface CommandProcessingContext

Parameters:

requirement - requirement to meet

Returns:

requirement result

report

public void report(Object source,
 @NotNull
 @NotNull BadCommandResponse response)

report a problem with command parsing

Specified by:

report in interface CommandProcessingContext

Parameters:

source - source reporter of the problem

response - response error description object

getReport

public BadCommandResponse getReport()

Retrieving the current report

Returns:

current report

clearReports

public void clearReports()

Clear the current report