Package dev.rollczi.litecommands.programmatic

Class LiteCommand<SENDER>

java.lang.Object

dev.rollczi.litecommands.programmatic.LiteCommand<SENDER>

public class LiteCommand<SENDER>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	aliases
protected final List<dev.rollczi.litecommands.argument.Argument<?>>	arguments
protected final List<dev.rollczi.litecommands.requirement.BindRequirement<?>>	bindRequirements
protected final List<dev.rollczi.litecommands.requirement.ContextRequirement<?>>	contextRequirements
protected Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,Object>	executor
protected final dev.rollczi.litecommands.meta.Meta	meta
protected final String	name
protected final List<LiteCommand<SENDER>>	subCommands
protected boolean	withExecutor

Constructor Summary

Constructors

Constructor	Description
LiteCommand(String name)
LiteCommand(String name, String... aliases)
LiteCommand(String name, List<String> aliases)

Method Summary

Modifier and Type	Method	Description
LiteCommand<SENDER>	argument(dev.rollczi.litecommands.argument.Argument<?> argument)
LiteCommand<SENDER>	argument(String name, Class<?> type)
LiteCommand<SENDER>	argumentFlag(String name)
LiteCommand<SENDER>	argumentJoin(String name)
LiteCommand<SENDER>	argumentJoin(String name, String separator, int limit)
LiteCommand<SENDER>	argumentNullable(String name, Class<?> type)
LiteCommand<SENDER>	argumentOptional(String name, Class<?> type)
LiteCommand<SENDER>	argumentQuoted(String name)
LiteCommand<SENDER>	async()
LiteCommand<SENDER>	bind(String name, Class<?> type)
LiteCommand<SENDER>	context(String name, Class<?> type)
protected void	execute(dev.rollczi.litecommands.command.executor.LiteContext<SENDER> context)
final LiteCommand<SENDER>	execute(Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor)
final LiteCommand<SENDER>	executeReturn(Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,Object> executor)
<T> LiteCommand<SENDER>	meta(dev.rollczi.litecommands.meta.MetaKey<T> key, T value)
final LiteCommand<SENDER>	onExecute(Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor)	Deprecated. Use execute(Consumer) instead
LiteCommand<SENDER>	permissions(String... permissions)
final LiteCommand<SENDER>	subCommands(LiteCommand<SENDER>... subCommands)
LiteCommand<SENDER>	withoutExecutor()	Disables the executor for this command.

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

aliases

protected final List<String> aliases

meta

protected final dev.rollczi.litecommands.meta.Meta meta

executor

protected Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,Object> executor

withExecutor

protected boolean withExecutor

arguments

protected final List<dev.rollczi.litecommands.argument.Argument<?>> arguments

contextRequirements

protected final List<dev.rollczi.litecommands.requirement.ContextRequirement<?>> contextRequirements

bindRequirements

protected final List<dev.rollczi.litecommands.requirement.BindRequirement<?>> bindRequirements

subCommands

protected final List<LiteCommand<SENDER>> subCommands

Constructor Details

LiteCommand

public LiteCommand(String name,
 List<String> aliases)

LiteCommand

public LiteCommand(String name)

LiteCommand

public LiteCommand(String name,
 String... aliases)

Method Details

argument

public LiteCommand<SENDER> argument(String name,
 Class<?> type)

argument

public LiteCommand<SENDER> argument(dev.rollczi.litecommands.argument.Argument<?> argument)

argumentQuoted

public LiteCommand<SENDER> argumentQuoted(String name)

argumentOptional

public LiteCommand<SENDER> argumentOptional(String name,
 Class<?> type)

argumentNullable

public LiteCommand<SENDER> argumentNullable(String name,
 Class<?> type)

argumentFlag

public LiteCommand<SENDER> argumentFlag(String name)

argumentJoin

public LiteCommand<SENDER> argumentJoin(String name)

argumentJoin

public LiteCommand<SENDER> argumentJoin(String name,
 String separator,
 int limit)

context

public LiteCommand<SENDER> context(String name,
 Class<?> type)

bind

public LiteCommand<SENDER> bind(String name,
 Class<?> type)

permissions

public LiteCommand<SENDER> permissions(String... permissions)

async

public LiteCommand<SENDER> async()

meta

public <T> LiteCommand<SENDER> meta(dev.rollczi.litecommands.meta.MetaKey<T> key,
 T value)

onExecute

@Deprecated
public final LiteCommand<SENDER> onExecute(Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor)

Deprecated.

Use execute(Consumer) instead

execute

public final LiteCommand<SENDER> execute(Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor)

executeReturn

@Experimental
public final LiteCommand<SENDER> executeReturn(Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,Object> executor)

withoutExecutor

@Experimental
public LiteCommand<SENDER> withoutExecutor()

Disables the executor for this command. Useful when you want to use subcommands only.

execute

protected void execute(dev.rollczi.litecommands.command.executor.LiteContext<SENDER> context)

subCommands

@SafeVarargs
public final LiteCommand<SENDER> subCommands(LiteCommand<SENDER>... subCommands)