Package io.github.projectunified.craftcommand.processor.model

Class CommandModel

java.lang.Object

io.github.projectunified.craftcommand.processor.model.CommandModel

public class CommandModel
extends Object

Model representing a parsed command or subcommand class.

Nested subcommand models are indexed by their class element on construction, so the model of any class in the command tree is resolved by a direct lookup instead of a tree walk.

Constructor Summary

Constructors

Constructor	Description
CommandModel(com.palantir.javapoet.ClassName className, String packageName, String commandName, List<String> aliases, String description, MethodModel defaultMethod, List<MethodModel> subcommands, List<CommandModel> nestedSubcommands, TypeElement element)

Method Summary

Modifier and Type	Method	Description
CommandModel	findModel(TypeElement targetClass)	Finds the model of a class within this command tree.
List<String>	getAliases()	Gets the aliases of the command.
com.palantir.javapoet.ClassName	getClassName()	Gets the ClassName of the command class.
String	getCommandName()	Gets the primary name of the command.
MethodModel	getDefaultMethod()	Gets the default execution method.
String	getDescription()	Gets the command description.
TypeElement	getElement()	Gets the underlying Java TypeElement of this class.
Map<TypeElement,CommandModel>	getNestedIndex()	Gets this model and every nested subcommand model indexed by their class element.
List<CommandModel>	getNestedSubcommands()	Gets the nested class-level subcommands.
String	getPackageName()	Gets the package name of the command class.
List<MethodModel>	getSubcommands()	Gets the method-level subcommands.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandModel

public CommandModel(com.palantir.javapoet.ClassName className,
 String packageName,
 String commandName,
 List<String> aliases,
 String description,
 MethodModel defaultMethod,
 List<MethodModel> subcommands,
 List<CommandModel> nestedSubcommands,
 TypeElement element)

Method Details

getClassName

public com.palantir.javapoet.ClassName getClassName()

Gets the ClassName of the command class.

Returns:

the class name

getPackageName

public String getPackageName()

Gets the package name of the command class.

Returns:

the package name

getCommandName

public String getCommandName()

Gets the primary name of the command.

Returns:

the command name

getAliases

public List<String> getAliases()

Gets the aliases of the command.

Returns:

the list of aliases

getDescription

public String getDescription()

Gets the command description.

Returns:

the description

getDefaultMethod

public MethodModel getDefaultMethod()

Gets the default execution method.

Returns:

the default method model, or null if none

getSubcommands

public List<MethodModel> getSubcommands()

Gets the method-level subcommands.

Returns:

the list of subcommands

getNestedSubcommands

public List<CommandModel> getNestedSubcommands()

Gets the nested class-level subcommands.

Returns:

the list of nested subcommands

getElement

public TypeElement getElement()

Gets the underlying Java TypeElement of this class.

Returns:

the type element

getNestedIndex

public Map<TypeElement,CommandModel> getNestedIndex()

Gets this model and every nested subcommand model indexed by their class element.

Returns:

map of class element to command model

findModel

public CommandModel findModel(TypeElement targetClass)

Finds the model of a class within this command tree.

Parameters:

targetClass - the class element to look up

Returns:

the matching model, or null if the class is not part of this tree