Package net.lucypoulton.squirtgun.command.argument

Class AbstractArgument<T>

java.lang.Object

net.lucypoulton.squirtgun.command.argument.AbstractArgument<T>

All Implemented Interfaces:

CommandArgument<T>

Direct Known Subclasses:

GreedyStringArgument, ListArgument, OnlinePlayerArgument, SingleWordArgument, SubcommandNodeArgument

public abstract class AbstractArgument<T>
extends Object
implements CommandArgument<T>

An abstract argument, encapsulating the name and description fields.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractArgument(String name, String description, boolean isOptional)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets this argument's description for use in help commands.
@NotNull String	getName()	Gets this argument's name.
boolean	isOptional()	Gets whether this argument is optional or not.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lucypoulton.squirtgun.command.argument.CommandArgument

getValue, tabComplete

Constructor Details

AbstractArgument

protected AbstractArgument(String name,
 String description,
 boolean isOptional)

Parameters:

name - the argument's name

description - the argument's description

Method Details

getName

@NotNull
public final @NotNull String getName()

Description copied from interface: CommandArgument

Gets this argument's name.

Specified by:

getName in interface CommandArgument<T>

Returns:

the name

getDescription

public final String getDescription()

Description copied from interface: CommandArgument

Gets this argument's description for use in help commands. This should be a simple, one-line sentence.

Specified by:

getDescription in interface CommandArgument<T>

Returns:

the description

isOptional

public boolean isOptional()

Description copied from interface: CommandArgument

Gets whether this argument is optional or not. This should not change how the argument behaves.

Specified by:

isOptional in interface CommandArgument<T>

toString

public String toString()

Overrides:

toString in class Object