Package io.github.projectunified.craftcommand.processor.bukkit

Class BukkitCommandProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.github.projectunified.craftcommand.processor.BaseCommandProcessor

io.github.projectunified.craftcommand.processor.bukkit.BukkitCommandProcessor

All Implemented Interfaces:

Processor

@AutoService(javax.annotation.processing.Processor.class)
@SupportedAnnotationTypes("io.github.projectunified.craftcommand.annotation.Command")
@SupportedSourceVersion(RELEASE_8)
public class BukkitCommandProcessor
extends BaseCommandProcessor

Annotation processor for Bukkit platforms. Generates custom Bukkit wrapper command executors extending org.bukkit.command.Command.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
BukkitCommandProcessor()

Method Summary

Modifier and Type	Method	Description
protected void	buildAdditionalHelpers(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model)	Generates additional platform-independent helper methods (like suggestBoolean and sender casting helpers).
protected void	buildEntryMethods(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model, TypeElement typeElement)	Generates Bukkit-specific wrapper entry methods.
protected void	configureConstructor(com.palantir.javapoet.MethodSpec.Builder constructorBuilder, CommandModel model)	Configures the constructor for platform-specific statements (e.g., registering command).
protected void	configureSuperType(com.palantir.javapoet.TypeSpec.Builder typeSpec)	Configures the super interfaces/classes that the generated wrapper should implement/extend.
protected void	generatePlatformParamSuggestions(com.palantir.javapoet.MethodSpec.Builder methodSpec, com.palantir.javapoet.TypeName typeName, String senderCastVar, String argsVar, String currentVar, int tempIdx)
protected void	generateUnknownSubcommandMessage(com.palantir.javapoet.MethodSpec.Builder methodSpec, CommandModel model)	Generates statements to handle cases where an unknown subcommand is typed.
protected com.palantir.javapoet.TypeName	getManagerType()	Returns the platform-specific command manager type.
protected int	getPlatformBuiltInWidth(com.palantir.javapoet.TypeName typeName)
protected com.palantir.javapoet.ClassName	getSenderTypeName()	Returns the platform-specific command sender type name (e.g.
protected String	getWrapperClassSuffix()	Returns the wrapper class suffix specific to the platform.
protected boolean	isPlatformBuiltInType(com.palantir.javapoet.TypeName typeName)
protected boolean	isSenderBaseType(com.palantir.javapoet.TypeName typeName)
protected boolean	isSenderType(com.palantir.javapoet.TypeName typeName)	Checks if the sender type is supported
protected void	onBeforeExecute(com.palantir.javapoet.MethodSpec.Builder methodSpec, Element element, String returnStatement)	Hook run prior to execution routing of a subcommand or command method.
protected void	onBeforeSuggest(com.palantir.javapoet.MethodSpec.Builder methodSpec, Element element)	Hook run before tab-completion routing of a subcommand or method.
protected void	onSuggestionAdd(com.palantir.javapoet.MethodSpec.Builder methodSpec, Element element, Runnable addSuggestions)	Hook to decide if a subcommand/method should be suggested during tab-completion.
protected void	resolvePlatformMultiParameter(com.palantir.javapoet.MethodSpec.Builder methodSpec, com.palantir.javapoet.TypeName typeName, String varName, String argsVar, String argIdxVar, String senderVar, int i)
protected void	resolvePlatformParameter(com.palantir.javapoet.MethodSpec.Builder methodSpec, com.palantir.javapoet.TypeName typeName, String varName, String argStrVar)

Methods inherited from class io.github.projectunified.craftcommand.processor.BaseCommandProcessor

buildAliasesExpression, buildBuiltInParameter, buildExecutionRouting, buildLocalResolverParameter, buildMethodExecution, buildMethodExecution, buildParameterSuggestionHelper, buildParameterSuggestions, buildSenderResolution, buildSubcommandSuggestionRouting, buildSuggestionRouting, buildWrapperClass, findLocalResolver, findModelForClass, findSuggestMethod, firstParamIsSender, generateDefaultSenderCastForSuggestion, generateExecuteMethodBody, generateFieldsAndConstructorStatements, generateLocalResolverInvocation, generateSubcommandClassExecutors, getAssignmentValueForType, getDefaultPrimitiveValue, getDynamicResolverTypes, getInstanceVarExpression, getLocalResolverMaxWidth, getLocalResolverMinWidth, getParameterSuggestionMethodName, getResolverMethodName, getSenderExpression, getSimpleName, getSubcommandFieldName, getSubcommandNames, getUsage, init, isBuiltInType, isField, process

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Details

BukkitCommandProcessor

public BukkitCommandProcessor()

Method Details

getWrapperClassSuffix

protected String getWrapperClassSuffix()

Description copied from class: BaseCommandProcessor

Returns the wrapper class suffix specific to the platform.

Specified by:

getWrapperClassSuffix in class BaseCommandProcessor

Returns:

the class name suffix (e.g. "_Executor" or "_Standalone")

configureSuperType

protected void configureSuperType(com.palantir.javapoet.TypeSpec.Builder typeSpec)

Description copied from class: BaseCommandProcessor

Configures the super interfaces/classes that the generated wrapper should implement/extend.

Specified by:

configureSuperType in class BaseCommandProcessor

Parameters:

typeSpec - the class definition builder

getSenderTypeName

protected com.palantir.javapoet.ClassName getSenderTypeName()

Description copied from class: BaseCommandProcessor

Returns the platform-specific command sender type name (e.g. Bukkit CommandSender or Object).

Specified by:

getSenderTypeName in class BaseCommandProcessor

getManagerType

protected com.palantir.javapoet.TypeName getManagerType()

Description copied from class: BaseCommandProcessor

Returns the platform-specific command manager type.

Specified by:

getManagerType in class BaseCommandProcessor

isSenderType

protected boolean isSenderType(com.palantir.javapoet.TypeName typeName)

Description copied from class: BaseCommandProcessor

Checks if the sender type is supported

Overrides:

isSenderType in class BaseCommandProcessor

isSenderBaseType

protected boolean isSenderBaseType(com.palantir.javapoet.TypeName typeName)

Overrides:

isSenderBaseType in class BaseCommandProcessor

configureConstructor

protected void configureConstructor(com.palantir.javapoet.MethodSpec.Builder constructorBuilder,
 CommandModel model)

Description copied from class: BaseCommandProcessor

Configures the constructor for platform-specific statements (e.g., registering command).

Overrides:

configureConstructor in class BaseCommandProcessor

buildEntryMethods

protected void buildEntryMethods(com.palantir.javapoet.TypeSpec.Builder typeSpec,
 CommandModel model,
 TypeElement typeElement)

Generates Bukkit-specific wrapper entry methods. This overrides org.bukkit.command.Command's execute and tabComplete methods.

Specified by:

buildEntryMethods in class BaseCommandProcessor

generateUnknownSubcommandMessage

protected void generateUnknownSubcommandMessage(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 CommandModel model)

Description copied from class: BaseCommandProcessor

Generates statements to handle cases where an unknown subcommand is typed.

Overrides:

generateUnknownSubcommandMessage in class BaseCommandProcessor

onBeforeExecute

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

Description copied from class: BaseCommandProcessor

Hook run prior to execution routing of a subcommand or command method.

Overrides:

onBeforeExecute in class BaseCommandProcessor

onSuggestionAdd

protected void onSuggestionAdd(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 Element element,
 Runnable addSuggestions)

Description copied from class: BaseCommandProcessor

Hook to decide if a subcommand/method should be suggested during tab-completion.

Overrides:

onSuggestionAdd in class BaseCommandProcessor

onBeforeSuggest

protected void onBeforeSuggest(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 Element element)

Description copied from class: BaseCommandProcessor

Hook run before tab-completion routing of a subcommand or method.

Overrides:

onBeforeSuggest in class BaseCommandProcessor

isPlatformBuiltInType

protected boolean isPlatformBuiltInType(com.palantir.javapoet.TypeName typeName)

Overrides:

isPlatformBuiltInType in class BaseCommandProcessor

getPlatformBuiltInWidth

protected int getPlatformBuiltInWidth(com.palantir.javapoet.TypeName typeName)

Overrides:

getPlatformBuiltInWidth in class BaseCommandProcessor

resolvePlatformParameter

protected void resolvePlatformParameter(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 com.palantir.javapoet.TypeName typeName,
 String varName,
 String argStrVar)

Overrides:

resolvePlatformParameter in class BaseCommandProcessor

resolvePlatformMultiParameter

protected void resolvePlatformMultiParameter(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 com.palantir.javapoet.TypeName typeName,
 String varName,
 String argsVar,
 String argIdxVar,
 String senderVar,
 int i)

Overrides:

resolvePlatformMultiParameter in class BaseCommandProcessor

generatePlatformParamSuggestions

protected void generatePlatformParamSuggestions(com.palantir.javapoet.MethodSpec.Builder methodSpec,
 com.palantir.javapoet.TypeName typeName,
 String senderCastVar,
 String argsVar,
 String currentVar,
 int tempIdx)

Overrides:

generatePlatformParamSuggestions in class BaseCommandProcessor

buildAdditionalHelpers

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

Description copied from class: BaseCommandProcessor

Generates additional platform-independent helper methods (like suggestBoolean and sender casting helpers).

Overrides:

buildAdditionalHelpers in class BaseCommandProcessor