Class BroadcastDocument

java.lang.Object
com.iohao.net.framework.core.doc.BroadcastDocument
public final class BroadcastDocument extends Object
Documentation model for a single broadcast (server-push) route, describing the command info, data type, method name, and associated metadata used for client SDK code generation.
Author:
渔民小镇
date:
2024-06-25

  • Field Details

    • cmdInfo

      public final CmdInfo cmdInfo
      The route (command info) for this broadcast.

    • methodDescription

      public String methodDescription
      Description of the broadcast method.

    • methodName

      public String methodName
      Method name (PascalCase).

    • cmdMethodName

      public String cmdMethodName
      Method name (camelCase) for command-style usage.

    • dataClass

      public Class<?> dataClass
      Business data type class.

    • dataClassName

      public String dataClassName
      Simple name of the business data type.

    • dataDescription

      public String dataDescription
      Description of the broadcast data parameter.

    • dataTypeIsInternal

      public boolean dataTypeIsInternal
      true if the data type is a built-in protocol fragment; false for user-defined types.

    • dataIsList

      public boolean dataIsList
      true if the broadcast data is a List type.

    • bizDataType

      public String bizDataType
      Mapped business data type name.

    • resultMethodTypeName

      public String resultMethodTypeName
      SDK result getter method name.

    • resultMethodListTypeName

      public String resultMethodListTypeName
      SDK result list getter method name.

    • dataActualTypeName

      public String dataActualTypeName
      Actual data type name.

    • exampleCode

      public String exampleCode
      Example code snippet.

    • exampleCodeAction

      public String exampleCodeAction
      Example action code snippet.

  • Method Details

    • getCmdMerge

      public int getCmdMerge()

    • getCmd

      public int getCmd()

    • getSubCmd

      public int getSubCmd()

    • builder

      public static BroadcastDocumentBuilder builder(CmdInfo cmdInfo)

    • newBuilder

      @Deprecated public static BroadcastDocumentBuilder newBuilder(CmdInfo cmdInfo)
      Deprecated.
      see builder(CmdInfo)
      create BroadcastDocumentBuilder
      Parameters:
      cmdInfo - cmdInfo
      Returns:
      BroadcastDocumentBuilder

    • getCmdInfo

      public CmdInfo getCmdInfo()
      The route (command info) for this broadcast.

    • getMethodDescription

      public String getMethodDescription()
      Description of the broadcast method.

    • getMethodName

      public String getMethodName()
      Method name (PascalCase).

    • getCmdMethodName

      public String getCmdMethodName()
      Method name (camelCase) for command-style usage.

    • getDataClass

      public Class<?> getDataClass()
      Business data type class.

    • getDataClassName

      public String getDataClassName()
      Simple name of the business data type.

    • getDataDescription

      public String getDataDescription()
      Description of the broadcast data parameter.

    • isDataTypeIsInternal

      public boolean isDataTypeIsInternal()
      true if the data type is a built-in protocol fragment; false for user-defined types.

    • isDataIsList

      public boolean isDataIsList()
      true if the broadcast data is a List type.

    • getBizDataType

      public String getBizDataType()
      Mapped business data type name.

    • getResultMethodTypeName

      public String getResultMethodTypeName()
      SDK result getter method name.

    • getResultMethodListTypeName

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

    • getDataActualTypeName

      public String getDataActualTypeName()
      Actual data type name.

    • getExampleCode

      public String getExampleCode()
      Example code snippet.

    • getExampleCodeAction

      public String getExampleCodeAction()
      Example action code snippet.