Class DocumentHelper

java.lang.Object
com.iohao.net.framework.core.doc.DocumentHelper
public class DocumentHelper extends Object
DocumentHelper

for example 

    // 添加自定义的文档生成器
    DocumentHelper.addDocumentGenerate(new YourDocumentGenerate());
    // 添加枚举错误码 class，用于生成错误码相关信息
    DocumentHelper.addErrorCodeClass(YourErrorCode.class);
    // 生成文档
    DocumentHelper.generateDocument();
Author:
渔民小镇
See Also:
date:
2024-07-05

  • Constructor Details

    • DocumentHelper

      public DocumentHelper()

  • Method Details

    • setGenerateDoc

      public void setGenerateDoc(boolean generateDoc)
      当为 false 时，将不会生成文档
      Parameters:
      generateDoc - generateDoc

    • generateDocument

      public void generateDocument()
      对接文档生成

    • addDocumentGenerate

      public void addDocumentGenerate(DocumentGenerate documentGenerate)
      添加文档生成器，相同类型只能添加一个
      Parameters:
      documentGenerate - 文档生成接口

    • addErrorCodeClass

      public void addErrorCodeClass(Class<? extends ErrorInformation> clazz)
      添加枚举错误码 class
      Parameters:
      clazz - 枚举错误码 class

    • addBroadcastDocument

      public void addBroadcastDocument(BroadcastDocument broadcastDocument)
      添加广播文档
      Parameters:
      broadcastDocument - broadcastDocument

    • addBroadcastDocument

      public void addBroadcastDocument(BroadcastDocumentBuilder broadcastDocumentBuilder)
      添加广播文档
      Parameters:
      broadcastDocumentBuilder - broadcastDocumentBuilder

    • ofActionDoc

      public ActionDoc ofActionDoc(int cmd, Class<?> controllerClazz)
      获取 ActionDoc，如果 ActionDoc 不存在则创建
      Parameters:
      cmd - 主路由
      controllerClazz - action class
      Returns:
      一定不为 null