Module net.minestom.server

Package net.minestom.server.command.builder

Class CommandContext

java.lang.Object

net.minestom.server.command.builder.CommandContext

public class CommandContext
extends Object

Class used to retrieve argument data in a CommandExecutor.

All id are the one specified in the Argument constructor.

All methods are @NotNull in the sense that you should not have to verify their validity since if the syntax is called, it means that all of its arguments are correct. Be aware that trying to retrieve an argument not present in the syntax will result in a NullPointerException.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	args
protected Map<String,String>	rawArgs

Constructor Summary

Constructors

Constructor	Description
CommandContext(String input)

Method Summary

Modifier and Type	Method	Description
protected void	clear()
void	copy(CommandContext context)
boolean	equals(Object o)
<T> T	get(String identifier)
<T> T	get(Argument<T> argument)
String	getCommandName()
String	getInput()
Map<String,Object>	getMap()
<T> T	getOrDefault(String identifier, T defaultValue)
<T> T	getOrDefault(Argument<T> argument, T defaultValue)
String	getRaw(String identifier)
String	getRaw(Argument<?> argument)
@Nullable CommandData	getReturnData()
boolean	has(String identifier)
boolean	has(Argument<?> argument)
int	hashCode()
protected void	retrieveDefaultValues(@Nullable Map<String,Supplier<Object>> defaultValuesMap)
void	setArg(String id, Object value, String rawInput)
void	setReturnData(@Nullable CommandData returnData)

Methods inherited from class java.lang.Object

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

Field Details

args

protected Map<String,Object> args

rawArgs

protected Map<String,String> rawArgs

Constructor Details

CommandContext

public CommandContext(String input)

Method Details

getInput

public String getInput()

getCommandName

public String getCommandName()

get

public <T> T get(Argument<T> argument)

get

public <T> T get(String identifier)

getOrDefault

public <T> T getOrDefault(Argument<T> argument,
 T defaultValue)

getOrDefault

public <T> T getOrDefault(String identifier,
 T defaultValue)

has

public boolean has(Argument<?> argument)

has

public boolean has(String identifier)

getReturnData

@Nullable
public @Nullable CommandData getReturnData()

setReturnData

public void setReturnData(@Nullable
 @Nullable CommandData returnData)

getMap

public Map<String,Object> getMap()

copy

public void copy(CommandContext context)

getRaw

public String getRaw(Argument<?> argument)

getRaw

public String getRaw(String identifier)

setArg

public void setArg(String id,
 Object value,
 String rawInput)

clear

protected void clear()

retrieveDefaultValues

protected void retrieveDefaultValues(@Nullable
 @Nullable Map<String,Supplier<Object>> defaultValuesMap)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object