dev.rollczi.litecommands.programmatic

Class LiteCommand<SENDER>

java.lang.Object

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

public class LiteCommand<SENDER>
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LiteCommand(java.lang.String name)
LiteCommand(java.lang.String name, java.util.List<java.lang.String> aliases)
LiteCommand(java.lang.String name, java.lang.String... aliases)

Method Summary

Modifier and Type	Method and Description
LiteCommand<SENDER>	argument(dev.rollczi.litecommands.argument.Argument<?> argument)
LiteCommand<SENDER>	argument(java.lang.String name, java.lang.Class<?> type)
LiteCommand<SENDER>	argumentFlag(java.lang.String... names)
LiteCommand<SENDER>	argumentFlag(java.lang.String name)
LiteCommand<SENDER>	argumentJoin(java.lang.String name)
LiteCommand<SENDER>	argumentJoin(java.lang.String name, java.lang.String separator, int limit)
<T> LiteCommand<SENDER>	argumentNullable(java.lang.String name, java.lang.Class<T> type)
<T> LiteCommand<SENDER>	argumentOptional(java.lang.String name, java.lang.Class<T> type)
LiteCommand<SENDER>	argumentQuoted(java.lang.String name)
LiteCommand<SENDER>	async()
LiteCommand<SENDER>	bind(java.lang.String name, java.lang.Class<?> type)
LiteCommand<SENDER>	context(java.lang.String name, java.lang.Class<?> type)
LiteCommand<SENDER>	description(java.lang.String... description)
LiteCommand<SENDER>	execute(java.util.function.Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor)
protected void	execute(dev.rollczi.litecommands.command.executor.LiteContext<SENDER> context)
LiteCommand<SENDER>	executeReturn(java.util.function.Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,java.lang.Object> executor)
<T> LiteCommand<SENDER>	executorMeta(dev.rollczi.litecommands.meta.MetaKey<T> key, T value)
LiteCommand<SENDER>	literal(java.lang.String... names)
LiteCommand<SENDER>	literalIgnoreCase(java.lang.String... names)
<T> LiteCommand<SENDER>	meta(dev.rollczi.litecommands.meta.MetaKey<T> key, T value)
LiteCommand<SENDER>	onExecute(java.util.function.Consumer<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>> executor) Deprecated. Use execute(Consumer) instead
LiteCommand<SENDER>	permissions(java.lang.String... permissions)
LiteCommand<SENDER>	strict(dev.rollczi.litecommands.strict.StrictMode strict)
LiteCommand<SENDER>	strictExecutor(dev.rollczi.litecommands.strict.StrictMode strict)
LiteCommand<SENDER>	subcommand(java.lang.String name, java.util.function.UnaryOperator<LiteCommand<SENDER>> operator)
LiteCommand<SENDER>	subcommands(LiteCommand<SENDER>... subCommands)
LiteCommand<SENDER>	subCommands(LiteCommand<SENDER>... subCommands) Deprecated.
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 Detail

name

protected final java.lang.String name

aliases

protected final java.util.List<java.lang.String> aliases

meta

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

executorMeta

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

executor

protected java.util.function.Function<dev.rollczi.litecommands.command.executor.LiteContext<SENDER>,java.lang.Object> executor

withExecutor

protected boolean withExecutor

arguments

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

contextRequirements

protected final java.util.List<dev.rollczi.litecommands.context.ContextRequirement<?>> contextRequirements

bindRequirements

protected final java.util.List<dev.rollczi.litecommands.bind.BindRequirement<?>> bindRequirements

subCommands

protected final java.util.List<LiteCommand<SENDER>> subCommands

Constructor Detail

LiteCommand

public LiteCommand(java.lang.String name,
                   java.util.List<java.lang.String> aliases)

LiteCommand

public LiteCommand(java.lang.String name)

LiteCommand

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

Method Detail

argument

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

argument

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

argumentQuoted

public LiteCommand<SENDER> argumentQuoted(java.lang.String name)

argumentOptional

public <T> LiteCommand<SENDER> argumentOptional(java.lang.String name,
                                                java.lang.Class<T> type)

argumentNullable

public <T> LiteCommand<SENDER> argumentNullable(java.lang.String name,
                                                java.lang.Class<T> type)

argumentFlag

public LiteCommand<SENDER> argumentFlag(java.lang.String name)

argumentFlag

public LiteCommand<SENDER> argumentFlag(java.lang.String... names)

argumentJoin

public LiteCommand<SENDER> argumentJoin(java.lang.String name)

argumentJoin

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

literal

public LiteCommand<SENDER> literal(java.lang.String... names)

literalIgnoreCase

public LiteCommand<SENDER> literalIgnoreCase(java.lang.String... names)

context

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

bind

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

permissions

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

async

public LiteCommand<SENDER> async()

meta

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

executorMeta

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

description

public LiteCommand<SENDER> description(java.lang.String... description)

onExecute

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

Deprecated. Use execute(Consumer) instead

execute

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

executeReturn

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

withoutExecutor

@ApiStatus.Experimental
public LiteCommand<SENDER> withoutExecutor()

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

strict

@ApiStatus.Experimental
public LiteCommand<SENDER> strict(dev.rollczi.litecommands.strict.StrictMode strict)

strictExecutor

@ApiStatus.Experimental
public LiteCommand<SENDER> strictExecutor(dev.rollczi.litecommands.strict.StrictMode strict)

execute

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

subCommands

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

Deprecated.

subcommands

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

subcommand

public final LiteCommand<SENDER> subcommand(java.lang.String name,
                                            java.util.function.UnaryOperator<LiteCommand<SENDER>> operator)