dev.rollczi.litecommands

Interface LiteCommandsBuilder<SENDER,SETTINGS extends dev.rollczi.litecommands.platform.PlatformSettings,B extends LiteCommandsBuilder<SENDER,SETTINGS,B>>

Type Parameters:

SENDER - type of sender

SETTINGS - type of platform settings

B - self type for builder

All Known Subinterfaces:

LiteCommandsAdvanced<SENDER,SETTINGS,B>

All Known Implementing Classes:

LiteCommandsBaseBuilder

public interface LiteCommandsBuilder<SENDER,SETTINGS extends dev.rollczi.litecommands.platform.PlatformSettings,B extends LiteCommandsBuilder<SENDER,SETTINGS,B>>

Builder for LiteCommands. Use LiteCommandsFactory.builder(Class, Platform) to create new instance of builder.

Method Summary

Modifier and Type	Method and Description
<A extends LiteCommandsAdvanced<SENDER,SETTINGS,A>> A	advanced() Returns advanced builder.
B	annotations(LiteConfigurator<AnnotationsExtension<SENDER>> configurator) [Experimental] Register extension for annotations processing/ Please note that this method is experimental and may be deprecated or removed in the future.
<T> B	argument(java.lang.Class<T> type, dev.rollczi.litecommands.argument.ArgumentKey key, dev.rollczi.litecommands.argument.resolver.ArgumentResolverBase<SENDER,T> resolver) [Keyed Argument Parser and Suggester] Register argument parser and suggester for a given type and key.
<T> B	argument(java.lang.Class<T> type, dev.rollczi.litecommands.argument.resolver.ArgumentResolverBase<SENDER,T> resolver) [Argument Parser and Suggester] Register argument parser and suggester for given type.
<T> B	argumentParser(java.lang.Class<T> type, dev.rollczi.litecommands.argument.ArgumentKey key, dev.rollczi.litecommands.argument.parser.Parser<SENDER,T> parser)
<T> B	argumentParser(java.lang.Class<T> type, dev.rollczi.litecommands.argument.parser.Parser<SENDER,T> parser)
<T> B	argumentSuggester(java.lang.Class<T> type, dev.rollczi.litecommands.argument.ArgumentKey key, dev.rollczi.litecommands.argument.suggester.Suggester<SENDER,T> suggester)
<T> B	argumentSuggester(java.lang.Class<T> type, dev.rollczi.litecommands.argument.suggester.Suggester<SENDER,T> suggester)
<T> B	argumentSuggestion(java.lang.Class<T> type, dev.rollczi.litecommands.argument.ArgumentKey key, dev.rollczi.litecommands.suggestion.SuggestionResult suggestion)
<T> B	argumentSuggestion(java.lang.Class<T> type, dev.rollczi.litecommands.suggestion.SuggestionResult suggestion)
default <T> B	bind(java.lang.Class<T> on, dev.rollczi.litecommands.bind.BindProvider<T> bindProvider)
<T> B	bind(java.lang.Class<T> on, java.util.function.Supplier<T> bind)
B	bindUnsafe(java.lang.Class<?> on, java.util.function.Supplier<?> bind)
dev.rollczi.litecommands.LiteCommands<SENDER>	build()
dev.rollczi.litecommands.LiteCommands<SENDER>	build(boolean register)
B	commands(dev.rollczi.litecommands.LiteCommandsProvider<SENDER> commandsProvider) Register commands from given provider.
B	commands(java.lang.Object... commands) This method is used to register additional commands.
default <T> B	context(java.lang.Class<T> on, dev.rollczi.litecommands.context.ContextProvider<SENDER,T> bind)
B	editor(dev.rollczi.litecommands.scope.Scope scope, dev.rollczi.litecommands.editor.Editor<SENDER> editor)
B	editorGlobal(dev.rollczi.litecommands.editor.Editor<SENDER> editor)
<E extends java.lang.Throwable> B	exception(java.lang.Class<E> exceptionType, dev.rollczi.litecommands.handler.exception.ExceptionHandler<SENDER,? extends E> handler)
B	exceptionUnexpected(dev.rollczi.litecommands.handler.exception.ExceptionHandler<SENDER,java.lang.Throwable> handler)
<CONFIGURATION,E extends LiteExtension<SENDER,CONFIGURATION>> B	extension(E extension, LiteConfigurator<CONFIGURATION> configurator) Register extension for this builder with configurator.
<CONFIGURATION> B	extension(LiteExtension<SENDER,CONFIGURATION> extension) Register extension for this builder.
B	invalidUsage(dev.rollczi.litecommands.invalidusage.InvalidUsageHandler<SENDER> handler)
<T,CONTEXT> B	message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key, dev.rollczi.litecommands.message.InvokedMessage<SENDER,T,CONTEXT> message)
<T,CONTEXT> B	message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key, dev.rollczi.litecommands.message.Message<T,CONTEXT> message)
<T,CONTEXT> B	message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key, T message)
B	missingPermission(dev.rollczi.litecommands.permission.MissingPermissionsHandler<SENDER> handler)
B	postProcessor(LiteBuilderProcessor<SENDER,SETTINGS> postProcessor)
B	preProcessor(LiteBuilderProcessor<SENDER,SETTINGS> preProcessor)
<T> B	result(java.lang.Class<T> resultType, dev.rollczi.litecommands.handler.result.ResultHandler<SENDER,? extends T> handler)
B	resultUnexpected(dev.rollczi.litecommands.handler.result.ResultHandler<SENDER,java.lang.Object> handler)
B	scheduler(dev.rollczi.litecommands.scheduler.Scheduler scheduler)
B	schematicGenerator(dev.rollczi.litecommands.schematic.SchematicFastFormat format)
B	schematicGenerator(dev.rollczi.litecommands.schematic.SchematicFormat format)
B	schematicGenerator(dev.rollczi.litecommands.schematic.SchematicGenerator<SENDER> schematicGenerator)
B	selfProcessor(LiteBuilderProcessor<SENDER,SETTINGS> processor)
B	settings(dev.rollczi.litecommands.platform.PlatformSettingsConfigurator<SETTINGS> configurator) Configure platform settings.
B	validator(dev.rollczi.litecommands.scope.Scope scope, dev.rollczi.litecommands.validator.Validator<SENDER> validator)
B	validatorGlobal(dev.rollczi.litecommands.validator.Validator<SENDER> validator)
default B	validatorMarked(dev.rollczi.litecommands.validator.Validator<SENDER> validator)
B	wrapper(dev.rollczi.litecommands.wrapper.Wrapper wrapper)

Method Detail

advanced

@ApiStatus.Experimental
<A extends LiteCommandsAdvanced<SENDER,SETTINGS,A>> A advanced()

Returns advanced builder. This builder is used to configure advanced settings.

settings

B settings(dev.rollczi.litecommands.platform.PlatformSettingsConfigurator<SETTINGS> configurator)

Configure platform settings.

Parameters:

configurator - configurator for platform settings

Returns:

this builder

See Also:

PlatformSettings

commands

B commands(dev.rollczi.litecommands.LiteCommandsProvider<SENDER> commandsProvider)

Register commands from given provider.

Parameters:

commandsProvider - provider of commands

Returns:

this builder

See Also:

commands(Object...), LiteCommandsProvider

commands

B commands(java.lang.Object... commands)

This method is used to register additional commands. There are several types of objects that can be registered: Using annotations:

• An instance annotated with Command
• An instance annotated with RootCommand
• A class annotated with Command
• A class annotated with RootCommand

Programmatically:

• An instance of LiteCommand

Please note that this method is experimental and may be deprecated or removed in the future.

Parameters:

commands - commands to register

Returns:

This method returns the current LiteCommand builder instance This allows you to chain multiple calls together, using the builder design pattern.

See Also:

commands(LiteCommandsProvider)

argumentParser

<T> B argumentParser(java.lang.Class<T> type,
                     dev.rollczi.litecommands.argument.parser.Parser<SENDER,T> parser)

argumentParser

<T> B argumentParser(java.lang.Class<T> type,
                     dev.rollczi.litecommands.argument.ArgumentKey key,
                     dev.rollczi.litecommands.argument.parser.Parser<SENDER,T> parser)

argumentSuggestion

<T> B argumentSuggestion(java.lang.Class<T> type,
                         dev.rollczi.litecommands.suggestion.SuggestionResult suggestion)

argumentSuggestion

<T> B argumentSuggestion(java.lang.Class<T> type,
                         dev.rollczi.litecommands.argument.ArgumentKey key,
                         dev.rollczi.litecommands.suggestion.SuggestionResult suggestion)

argumentSuggester

<T> B argumentSuggester(java.lang.Class<T> type,
                        dev.rollczi.litecommands.argument.suggester.Suggester<SENDER,T> suggester)

argumentSuggester

<T> B argumentSuggester(java.lang.Class<T> type,
                        dev.rollczi.litecommands.argument.ArgumentKey key,
                        dev.rollczi.litecommands.argument.suggester.Suggester<SENDER,T> suggester)

argument

<T> B argument(java.lang.Class<T> type,
               dev.rollczi.litecommands.argument.resolver.ArgumentResolverBase<SENDER,T> resolver)

[Argument Parser and Suggester] Register argument parser and suggester for given type.

Parameters:

type - type of argument

resolver - parser and suggester for a given type

Returns:

this builder

argument

<T> B argument(java.lang.Class<T> type,
               dev.rollczi.litecommands.argument.ArgumentKey key,
               dev.rollczi.litecommands.argument.resolver.ArgumentResolverBase<SENDER,T> resolver)

[Keyed Argument Parser and Suggester] Register argument parser and suggester for a given type and key. Key is used to define namespace for given parser. It is used to identify which parsers with same type should be used. Argument type is used to define what type is compatible with given parser.

Parameters:

type - type of argument

key - key of argument

resolver - parser and suggester for a given type

Returns:

this builder

context

default <T> B context(java.lang.Class<T> on,
                      dev.rollczi.litecommands.context.ContextProvider<SENDER,T> bind)

bind

default <T> B bind(java.lang.Class<T> on,
                   dev.rollczi.litecommands.bind.BindProvider<T> bindProvider)

bind

<T> B bind(java.lang.Class<T> on,
           java.util.function.Supplier<T> bind)

bindUnsafe

B bindUnsafe(java.lang.Class<?> on,
             java.util.function.Supplier<?> bind)

scheduler

B scheduler(dev.rollczi.litecommands.scheduler.Scheduler scheduler)

message

<T,CONTEXT> B message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key,
                      dev.rollczi.litecommands.message.Message<T,CONTEXT> message)

message

<T,CONTEXT> B message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key,
                      dev.rollczi.litecommands.message.InvokedMessage<SENDER,T,CONTEXT> message)

message

<T,CONTEXT> B message(dev.rollczi.litecommands.message.MessageKey<CONTEXT> key,
                      T message)

editorGlobal

B editorGlobal(dev.rollczi.litecommands.editor.Editor<SENDER> editor)

editor

B editor(dev.rollczi.litecommands.scope.Scope scope,
         dev.rollczi.litecommands.editor.Editor<SENDER> editor)

validatorGlobal

B validatorGlobal(dev.rollczi.litecommands.validator.Validator<SENDER> validator)

validator

B validator(dev.rollczi.litecommands.scope.Scope scope,
            dev.rollczi.litecommands.validator.Validator<SENDER> validator)

validatorMarked

default B validatorMarked(dev.rollczi.litecommands.validator.Validator<SENDER> validator)

result

<T> B result(java.lang.Class<T> resultType,
             dev.rollczi.litecommands.handler.result.ResultHandler<SENDER,? extends T> handler)

resultUnexpected

B resultUnexpected(dev.rollczi.litecommands.handler.result.ResultHandler<SENDER,java.lang.Object> handler)

exception

<E extends java.lang.Throwable> B exception(java.lang.Class<E> exceptionType,
                                            dev.rollczi.litecommands.handler.exception.ExceptionHandler<SENDER,? extends E> handler)

exceptionUnexpected

B exceptionUnexpected(dev.rollczi.litecommands.handler.exception.ExceptionHandler<SENDER,java.lang.Throwable> handler)

missingPermission

B missingPermission(dev.rollczi.litecommands.permission.MissingPermissionsHandler<SENDER> handler)

invalidUsage

B invalidUsage(dev.rollczi.litecommands.invalidusage.InvalidUsageHandler<SENDER> handler)

wrapper

B wrapper(dev.rollczi.litecommands.wrapper.Wrapper wrapper)

schematicGenerator

B schematicGenerator(dev.rollczi.litecommands.schematic.SchematicGenerator<SENDER> schematicGenerator)

schematicGenerator

B schematicGenerator(dev.rollczi.litecommands.schematic.SchematicFormat format)

schematicGenerator

B schematicGenerator(dev.rollczi.litecommands.schematic.SchematicFastFormat format)

selfProcessor

B selfProcessor(LiteBuilderProcessor<SENDER,SETTINGS> processor)

preProcessor

B preProcessor(LiteBuilderProcessor<SENDER,SETTINGS> preProcessor)

postProcessor

B postProcessor(LiteBuilderProcessor<SENDER,SETTINGS> postProcessor)

extension

<CONFIGURATION> B extension(LiteExtension<SENDER,CONFIGURATION> extension)

Register extension for this builder.

Type Parameters:

CONFIGURATION - type of configuration

Parameters:

extension - extension to register Example:

  
  .extension(new LiteAdventureExtension<>())
  
 

Returns:

this builder

extension

<CONFIGURATION,E extends LiteExtension<SENDER,CONFIGURATION>> B extension(E extension,
                                                                          LiteConfigurator<CONFIGURATION> configurator)

Register extension for this builder with configurator.

Type Parameters:

CONFIGURATION - type of configuration

Parameters:

extension - extension to register

configurator - configurator for extension Example:

  
  .extension(new LiteAdventureExtension<>(), configuration -> configuration
    .colorizeArgument(true)
    .miniMessage(true)
    .legacyColor(true)
    .serializer(ComponentSerializer.miniMessage())
  )
  
 

Returns:

this builder

annotations

@ApiStatus.Experimental
B annotations(LiteConfigurator<AnnotationsExtension<SENDER>> configurator)

[Experimental] Register extension for annotations processing/ Please note that this method is experimental and may be deprecated or removed in the future.

Parameters:

configurator - configurator for extension

• processor - register new annotation processor
• validator - register new validator for requirement

Example:

 
 .extensionAnnotation(extension -> extension
     .processor(new MyAnnotationProcessor())
     .validator(String.class, IsValid.class, new StringValidator())
 )
 
 

Returns:

this builder

build

dev.rollczi.litecommands.LiteCommands<SENDER> build()

build

dev.rollczi.litecommands.LiteCommands<SENDER> build(boolean register)