Package io.github.projectunified.craftcommand.processor

Class BaseCommandProcessor

java.lang.Object
javax.annotation.processing.AbstractProcessor
io.github.projectunified.craftcommand.processor.BaseCommandProcessor
All Implemented Interfaces:
Processor
Direct Known Subclasses:
BukkitCommandProcessor, PaperCommandProcessor, StandaloneCommandProcessor
public abstract class BaseCommandProcessor extends AbstractProcessor
Lightweight, human-readable base annotation processor for CraftCommand. Supports custom validation annotations, parameter resolvers, deep subcommand nesting, and SPI extensions.

  • Field Details

    • typeSupport

      protected final TypeSupport typeSupport

  • Constructor Details

    • BaseCommandProcessor

      public BaseCommandProcessor()

  • Method Details

    • getUsage

      protected static String getUsage(MethodModel method)

    • getSimpleName

      public static String getSimpleName(com.palantir.javapoet.TypeName typeName)

    • getSubcommandNames

      protected static String getSubcommandNames(CommandModel model)

    • isI18nKey

      protected static boolean isI18nKey(String message)

    • i18nKey

      protected static String i18nKey(String message)

    • typeSupport

      public TypeSupport typeSupport()

    • init

      public void init(ProcessingEnvironment processingEnv)
      Specified by:
      init in interface Processor
      Overrides:
      init in class AbstractProcessor

    • process

      public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
      Specified by:
      process in interface Processor
      Specified by:
      process in class AbstractProcessor

    • registerTypes

      protected void registerTypes(TypeSupport types)

    • runParameterAnnotationHandlers

      public void runParameterAnnotationHandlers(ParameterModel param, String varName, String instanceExpr, String senderVar, com.palantir.javapoet.MethodSpec.Builder methodSpec)
      Runs the SPI parameter handlers of a resolved parameter, delegating to the execution generator.
      Parameters:
      param - the parameter that was resolved
      varName - the generated local holding its value
      instanceExpr - the command instance expression
      senderVar - the local holding the command sender
      methodSpec - the method being generated

    • generateResolverInvocation

      public void generateResolverInvocation(com.palantir.javapoet.MethodSpec.Builder methodSpec, MethodModel resolverModel, CommandModel rootModel, com.palantir.javapoet.TypeName pTypeName, String varName, String senderVarName, List<String> resolverArgVarNames, boolean includeSender)
      Emits the call to a resolver method that produces a parameter value, delegating to the execution generator.
      Parameters:
      methodSpec - the method being generated
      resolverModel - the resolver method
      rootModel - the root command model
      pTypeName - the resolved parameter type
      varName - the local receiving the resolved value
      senderVarName - the local holding the command sender
      resolverArgVarNames - the locals holding the resolver arguments
      includeSender - whether the sender is passed to the resolver

    • getWrapperClassSuffix

      protected abstract String getWrapperClassSuffix()

    • getSenderTypeName

      protected abstract com.palantir.javapoet.ClassName getSenderTypeName()

    • getManagerType

      protected abstract com.palantir.javapoet.TypeName getManagerType()

    • configureClass

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

    • addPlatformFields

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

    • addConstructorStatements

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

    • generateEntryMethods

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

    • generatePlatformHelpers

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

    • onBeforeExecute

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

    • generateUnknownSubcommandMessage

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

    • getSenderExpression

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

    • buildWrapperClass

      protected void buildWrapperClass(CommandModel model, TypeElement typeElement) throws IOException
      Throws:
      IOException

    • generateHelpers

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

    • generateSubcommandFieldsAndConstructors

      protected void generateSubcommandFieldsAndConstructors(CommandModel model, com.palantir.javapoet.TypeSpec.Builder typeSpec, com.palantir.javapoet.MethodSpec.Builder constructor, String parentFieldName)

    • getSubcommandFieldName

      protected String getSubcommandFieldName(CommandModel child)

    • getInstanceVarExpression

      public String getInstanceVarExpression(CommandModel classModel, CommandModel rootModel)

    • getResolverInstanceExpr

      public String getResolverInstanceExpr(MethodModel resolver, CommandModel rootModel)

    • generateExecuteMethodBody

      public void generateExecuteMethodBody(com.palantir.javapoet.MethodSpec.Builder executeSpec, CommandModel model, String returnStatement)

    • generateSubcommandClassExecutors

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

    • buildSuggestionRouting

      protected void buildSuggestionRouting(com.palantir.javapoet.MethodSpec.Builder methodSpec, CommandModel model, String argsVar, String instanceVar, CommandModel rootModel)
      Generates tab completion for a command class, delegating to the suggestion generator.
      Parameters:
      methodSpec - the entry method being generated
      model - the command class
      argsVar - the argument array in scope
      instanceVar - the command instance expression
      rootModel - the root command model

    • buildSenderCastHelpers

      protected void buildSenderCastHelpers(com.palantir.javapoet.TypeSpec.Builder typeSpec, CommandModel model)
      Generates the sender cast helpers a command class needs, delegating to the suggestion generator.
      Parameters:
      typeSpec - the wrapper class being generated
      model - the command class

    • getParameterSuggestionMethodName

      protected String getParameterSuggestionMethodName(CommandModel classModel, MethodModel method, int index)
      The generated helper name for a parameter's suggestions.

    • getResolverParamSuggestionMethodName

      protected String getResolverParamSuggestionMethodName(CommandModel classModel, MethodModel method, String resolverName, int index)
      The generated helper name for a resolver parameter's suggestions.

    • buildCommandInfo

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

    • isField

      protected boolean isField(TypeElement typeElement, String name)

    • getBuiltInWidth

      public int getBuiltInWidth(com.palantir.javapoet.TypeName typeName)

    • isPlatformBuiltInType

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

    • isSenderType

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

    • isSenderBaseType

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

    • isSenderParam

      public boolean isSenderParam(com.palantir.javapoet.TypeName typeName, MethodModel method)

    • senderTypeRegistry

      protected SenderTypeRegistry senderTypeRegistry()

    • firstParamIsSender

      public boolean firstParamIsSender(ExecutableElement method)

    • firstParamIsSender

      public boolean firstParamIsSender(ExecutableElement resolverMethod, MethodModel commandMethod)

    • getLocalResolverMinWidth

      public int getLocalResolverMinWidth(MethodModel resolverModel, MethodModel commandMethod)

    • getLocalResolverMaxWidth

      public int getLocalResolverMaxWidth(MethodModel resolverModel, MethodModel commandMethod)

    • getResolverSenderExpression

      public String getResolverSenderExpression(ExecutableElement localResolver, String rawSourceExpr, String castSenderVar, com.palantir.javapoet.TypeName commandSenderType)

    • buildAliasesExpression

      protected com.palantir.javapoet.CodeBlock buildAliasesExpression(CommandModel model)