Package io.github.projectunified.craftcommand.processor.paper

Class PaperCommandGenerator

java.lang.Object

io.github.projectunified.craftcommand.processor.generator.BaseCommandGenerator

io.github.projectunified.craftcommand.processor.paper.PaperCommandGenerator

All Implemented Interfaces:

CommandGenerator

public final class PaperCommandGenerator
extends BaseCommandGenerator

Generates *$PaperCommand wrappers with a native Brigadier tree.

Field Summary

Fields inherited from class io.github.projectunified.craftcommand.processor.generator.BaseCommandGenerator

DEFAULT_PERMISSION_MESSAGE, PERMISSION_KEY

Constructor Summary

Constructors

Constructor	Description
PaperCommandGenerator(ProcessingEnvironment processingEnvironment)

Method Summary

Modifier and Type	Method	Description
protected void	configureClass(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model)	Configures the generated class declaration (superclass, interfaces).
protected void	generateEntryMethods(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model)	Adds the platform entry points (execute, tabComplete, getCommandNode, ...).
protected void	generateHelpers(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model)	Generates the execution and suggestion routing plus the sender helpers of the whole command tree.
protected com.palantir.javapoet.TypeName	getManagerType()	The CommandManager type, including its sender type argument.
protected com.palantir.javapoet.CodeBlock	getSenderExpression(String senderVar)	Wraps the raw sender variable in the platform expression that yields the sender object.
com.palantir.javapoet.ClassName	getSenderTypeName()	The platform's native sender type.
protected String	getWrapperClassSuffix()	The suffix appended to the command class name, for example "$BukkitCommand".
protected void	onBeforeExecute(com.palantir.javapoet.MethodSpec.Builder methodSpec, Element element, String returnStatement)	Runs before a command method is executed, for example a permission check.

Methods inherited from class io.github.projectunified.craftcommand.processor.generator.BaseCommandGenerator

addConstructorStatements, anyMethod, buildAliasesExpression, buildCommandInfo, buildSenderCastHelpers, buildSuggestionRouting, buildTypeSuggestionHelpers, call, firstParamIsSender, firstParamIsSender, generate, generateExecuteMethodBody, generatePlatformHelpers, generateResolverInvocation, generateSenderResolution, generateSubcommandClassExecutors, generateSubcommandFieldsAndConstructors, generateUnknownSubcommandMessage, getBuiltInWidth, getInstanceVarExpression, getLocalResolverMaxWidth, getLocalResolverMinWidth, getParameterSuggestionMethodName, getResolverInstanceExpr, getResolverParamSuggestionMethodName, getResolverSenderExpression, getSubcommandFieldName, getSubcommandNames, i18nKey, isI18nKey, isSenderBaseType, isSenderParam, isSenderType, runParameterAnnotationHandlers, senderTypeRegistry, typeSupport

Methods inherited from class java.lang.Object

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

Constructor Details

PaperCommandGenerator

public PaperCommandGenerator(ProcessingEnvironment processingEnvironment)

Method Details

getWrapperClassSuffix

protected String getWrapperClassSuffix()

Description copied from class: BaseCommandGenerator

The suffix appended to the command class name, for example "$BukkitCommand".

Specified by:

getWrapperClassSuffix in class BaseCommandGenerator

configureClass

protected void configureClass(com.palantir.javapoet.TypeSpec.Builder typeSpec,
 CommandModel model)

Description copied from class: BaseCommandGenerator

Configures the generated class declaration (superclass, interfaces).

Overrides:

configureClass in class BaseCommandGenerator

getSenderTypeName

public com.palantir.javapoet.ClassName getSenderTypeName()

Description copied from class: BaseCommandGenerator

The platform's native sender type.

Specified by:

getSenderTypeName in class BaseCommandGenerator

getManagerType

protected com.palantir.javapoet.TypeName getManagerType()

Description copied from class: BaseCommandGenerator

The CommandManager type, including its sender type argument.

Specified by:

getManagerType in class BaseCommandGenerator

getSenderExpression

protected com.palantir.javapoet.CodeBlock getSenderExpression(String senderVar)

Description copied from class: BaseCommandGenerator

Wraps the raw sender variable in the platform expression that yields the sender object.

Overrides:

getSenderExpression in class BaseCommandGenerator

generateEntryMethods

protected void generateEntryMethods(com.palantir.javapoet.TypeSpec.Builder typeSpec,
 CommandModel model)

Description copied from class: BaseCommandGenerator

Adds the platform entry points (execute, tabComplete, getCommandNode, ...).

Specified by:

generateEntryMethods in class BaseCommandGenerator

generateHelpers

protected void generateHelpers(com.palantir.javapoet.TypeSpec.Builder typeSpec,
 CommandModel model)

Description copied from class: BaseCommandGenerator

Generates the execution and suggestion routing plus the sender helpers of the whole command tree.

Overrides:

generateHelpers in class BaseCommandGenerator

onBeforeExecute

protected void onBeforeExecute(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 Element element,
 String returnStatement)

Description copied from class: BaseCommandGenerator

Runs before a command method is executed, for example a permission check.

Overrides:

onBeforeExecute in class BaseCommandGenerator