com.datasiqn.commandcore

Class InitOptions.Builder

java.lang.Object

com.datasiqn.commandcore.InitOptions.Builder

Enclosing class:

InitOptions

public static class InitOptions.Builder
extends Object

Builder class to create an InitOptions object

Constructor Summary

Constructors

Constructor and Description
Builder(@NotNull String rootCommand) Creates a new Builder class

Method Summary

Modifier and Type	Method and Description
InitOptions.Builder	aliases(String... aliases) Sets the aliases of the root command
InitOptions	build() Creates a new InitOptions based off this builder
static @NotNull InitOptions.Builder	create(@NotNull String rootCommand) Creates a new Builder instance.
InitOptions.Builder	createHelpCommand(boolean flag) Sets whether a help command should be created or not
InitOptions.Builder	pluginName(@NotNull String name) Sets the custom plugin name that appears when showing the help screen
InitOptions.Builder	warnOn(InitOptions.Warning... warnings) Tells CommandCore what warnings it should give when you register a command

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NotNull
               @NotNull String rootCommand)

Creates a new Builder class

Parameters:

rootCommand - The name of the root command that be the root all CommandCore commands

Method Detail

createHelpCommand

public InitOptions.Builder createHelpCommand(boolean flag)

Sets whether a help command should be created or not

Parameters:

flag - true if a help command should be created, false if it shouldn't

Returns:

The builder, for chaining

pluginName

public InitOptions.Builder pluginName(@NotNull
                                      @NotNull String name)

Sets the custom plugin name that appears when showing the help screen

Parameters:

name - The custom plugin name

Returns:

The builder, for chaining

aliases

public InitOptions.Builder aliases(@NotNull
                                   String... aliases)

Sets the aliases of the root command

Parameters:

aliases - The aliases

Returns:

The builder, for chaining

warnOn

public InitOptions.Builder warnOn(@NotNull
                                  InitOptions.Warning... warnings)

Tells CommandCore what warnings it should give when you register a command

Parameters:

warnings - The warnings

Returns:

The builder, for chaining

build

public InitOptions build()

Creates a new InitOptions based off this builder

Returns:

The newly created InitOptions instance

create

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public static @NotNull InitOptions.Builder create(@NotNull
                                                                                                                @NotNull String rootCommand)

Creates a new Builder instance. This is identical to calling new Builder(rootCommand).

Parameters:

rootCommand - The name of the root command that will be the root of all CommandCore commands

Returns:

The newly created Builder instance