Package com.kamikazejam.kamicommon.command

Class Parameter<T>

java.lang.Object

com.kamikazejam.kamicommon.command.Parameter<T>

public class Parameter<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Builder<T>

Method Summary

Modifier and Type	Method	Description
static <T> Parameter.Builder<T>	builder(@NotNull Type<T> type)
@Nullable String	getDefaultDesc()
@NotNull String	getTemplate(@Nullable CommandSender sender)
boolean	isDefaultValueSet()
boolean	isOptional()
boolean	isOptionalFor(CommandSender sender)
boolean	isRequired()
boolean	isRequiredFor(@Nullable CommandSender sender)
static <T> Parameter.Builder<T>	of(@NotNull Type<T> type)

Methods inherited from class java.lang.Object

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

Method Details

isRequired

public boolean isRequired()

isOptional

public boolean isOptional()

isDefaultValueSet

public boolean isDefaultValueSet()

Returns:

IFF a default value is set (may still be null)

getDefaultDesc

@Nullable
public @Nullable String getDefaultDesc()

Returns:

null if no default value is set, or the description of the default value if set, otherwise the default value as a string

isRequiredFor

public boolean isRequiredFor(@Nullable
 @Nullable CommandSender sender)

isOptionalFor

public boolean isOptionalFor(CommandSender sender)

getTemplate

@NotNull
public @NotNull String getTemplate(@Nullable
 @Nullable CommandSender sender)

builder

@NotNull
public static <T> Parameter.Builder<T> builder(@NotNull
 @NotNull Type<T> type)

of

@NotNull
public static <T> Parameter.Builder<T> of(@NotNull
 @NotNull Type<T> type)