com.datasiqn.commandcore

Class InitOptions

java.lang.Object

com.datasiqn.commandcore.InitOptions

public class InitOptions
extends Object

Initialization options used when initializing CommandCore. Cannot be created directly, and must use a Builder to create one.

See Also:

InitOptions.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InitOptions.Builder Builder class to create an InitOptions object
static class	InitOptions.Warning A collection of possible errors when making command creation

Constructor Summary

Constructors

Constructor and Description
InitOptions(@NotNull InitOptions.Builder builder) Creates an InitOptions from a Builder

Method Summary

Modifier and Type	Method and Description
boolean	createHelpCommand() Gets whether a help command should be generated or not
@UnmodifiableView List<String>	getAliases() Gets all the command's aliases
@Nullable String	getPluginName() Gets the custom plugin name
String	getRootCommand() Gets the root command
boolean	hasCustomPluginName() Gets whether the user has defined a custom plugin name or not
@UnmodifiableView boolean	shouldWarn(@NotNull InitOptions.Warning warning) Gets whether it should warn the user on a specific warning or not
void	warnIf(@NotNull InitOptions.Warning warning, boolean condition, Object... args) Warns a specific warning if a condition is met and shouldWarn(warning) returns true

Methods inherited from class java.lang.Object

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

Constructor Detail

InitOptions

@Contract(pure=true)
public InitOptions(@NotNull
                                         @NotNull InitOptions.Builder builder)

Creates an InitOptions from a Builder

Parameters:

builder - The builder

Method Detail

getRootCommand

public String getRootCommand()

Gets the root command

Returns:

The root command

hasCustomPluginName

public boolean hasCustomPluginName()

Gets whether the user has defined a custom plugin name or not

Returns:

true if there is a custom plugin name, false otherwise

getPluginName

@Nullable
public @Nullable String getPluginName()

Gets the custom plugin name

Returns:

The custom plugin name, or null if there is none

getAliases

public @UnmodifiableView List<String> getAliases()

Gets all the command's aliases

Returns:

An unmodifiable view of all the command's aliases

shouldWarn

public @UnmodifiableView boolean shouldWarn(@NotNull
                                            @NotNull InitOptions.Warning warning)

Gets whether it should warn the user on a specific warning or not

Parameters:

warning - The warning to check for

Returns:

true if it should warn, false otherwise

warnIf

public void warnIf(@NotNull
                   @NotNull InitOptions.Warning warning,
                   boolean condition,
                   Object... args)

Warns a specific warning if a condition is met and shouldWarn(warning) returns true

Parameters:

warning - The warning to warn

condition - The condition to meet in order to warn

args - The args used to format the warning message

createHelpCommand

public boolean createHelpCommand()

Gets whether a help command should be generated or not

Returns:

true if a help command should be generated, false otherwise