Class ActionMethodDocument

java.lang.Object
com.iohao.net.framework.core.doc.ActionMethodDocument
public final class ActionMethodDocument extends Object
Documentation model for a single action method, capturing parameter types, return types, comments, and type-mapping information used for client SDK code generation.
Author:
渔民小镇
date:
2024-06-26

  • Field Details

    • actionCommandDoc

      public final ActionCommandDoc actionCommandDoc

    • typeMappingDocument

      public final TypeMappingDocument typeMappingDocument

    • actionSimpleName

      public final String actionSimpleName
      Controller class simple name.

    • actionMethodName

      public String actionMethodName
      Action method name (PascalCase).

    • methodComment

      public final String methodComment
      Javadoc comment of the method.

    • hasBizData

      public final boolean hasBizData
      true if the method has a business data parameter.

    • bizDataName

      public String bizDataName
      Parameter name.

    • bizDataTypeClazz

      public Class<?> bizDataTypeClazz
      Parameter type class.

    • bizDataType

      public String bizDataType
      Mapped parameter type name.

    • bizDataComment

      public String bizDataComment
      Parameter comment.

    • bizDataTypeIsList

      public boolean bizDataTypeIsList
      true if the parameter is a List type.

    • internalBizDataType

      public boolean internalBizDataType
      true if the parameter type is a built-in protocol fragment.

    • actualTypeName

      public String actualTypeName
      Actual (generic) type name of the parameter.

    • memberCmdName

      public String memberCmdName
      Route member constant name.

    • sdkMethodName

      public String sdkMethodName
      SDK API method name.

    • isVoid

      public boolean isVoid

    • returnComment

      public String returnComment
      Return value comment.

    • returnDataName

      public String returnDataName

    • returnTypeClazz

      public Class<?> returnTypeClazz
      Return value type class.

    • returnDataActualTypeName

      public String returnDataActualTypeName
      Actual (generic) type name of the return value.

    • returnDataIsList

      public boolean returnDataIsList

    • returnDataTypeIsInternal

      public boolean returnDataTypeIsInternal
      true if the return type is a built-in protocol fragment.

    • resultMethodTypeName

      public String resultMethodTypeName
      SDK result getter method name.

    • resultMethodListTypeName

      public String resultMethodListTypeName
      SDK result list getter method name.

  • Constructor Details

    • ActionMethodDocument

      public ActionMethodDocument(ActionCommandDoc actionCommandDoc, TypeMappingDocument typeMappingDocument)
      Create a new method document from the given command doc and type mapping.
      Parameters:
      actionCommandDoc - the command-level documentation
      typeMappingDocument - the type mapping configuration

  • Method Details

    • getActionCommandDoc

      public ActionCommandDoc getActionCommandDoc()

    • getTypeMappingDocument

      public TypeMappingDocument getTypeMappingDocument()

    • getActionSimpleName

      public String getActionSimpleName()
      Controller class simple name.

    • getActionMethodName

      public String getActionMethodName()
      Action method name (PascalCase).

    • getMethodComment

      public String getMethodComment()
      Javadoc comment of the method.

    • isHasBizData

      public boolean isHasBizData()
      true if the method has a business data parameter.

    • getBizDataName

      public String getBizDataName()
      Parameter name.

    • getBizDataTypeClazz

      public Class<?> getBizDataTypeClazz()
      Parameter type class.

    • getBizDataType

      public String getBizDataType()
      Mapped parameter type name.

    • getBizDataComment

      public String getBizDataComment()
      Parameter comment.

    • isBizDataTypeIsList

      public boolean isBizDataTypeIsList()
      true if the parameter is a List type.

    • isInternalBizDataType

      public boolean isInternalBizDataType()
      true if the parameter type is a built-in protocol fragment.

    • getActualTypeName

      public String getActualTypeName()
      Actual (generic) type name of the parameter.

    • getMemberCmdName

      public String getMemberCmdName()
      Route member constant name.

    • getSdkMethodName

      public String getSdkMethodName()
      SDK API method name.

    • isVoid

      public boolean isVoid()

    • getReturnComment

      public String getReturnComment()
      Return value comment.

    • getReturnDataName

      public String getReturnDataName()

    • getReturnTypeClazz

      public Class<?> getReturnTypeClazz()
      Return value type class.

    • getReturnDataActualTypeName

      public String getReturnDataActualTypeName()
      Actual (generic) type name of the return value.

    • isReturnDataIsList

      public boolean isReturnDataIsList()

    • isReturnDataTypeIsInternal

      public boolean isReturnDataTypeIsInternal()
      true if the return type is a built-in protocol fragment.

    • getResultMethodTypeName

      public String getResultMethodTypeName()
      SDK result getter method name.

    • getResultMethodListTypeName

      public String getResultMethodListTypeName()
      SDK result list getter method name.