Class DocumentHelper

java.lang.Object
com.iohao.net.framework.core.doc.DocumentHelper
public final class DocumentHelper extends Object
Central helper for collecting action documentation, broadcast documents, error codes, and triggering document generation.

Usage example: 

    // Add a custom document generator
    DocumentHelper.addDocumentGenerate(new YourDocumentGenerate());
    // Add error code enum class for error code documentation
    DocumentHelper.addErrorCodeClass(YourErrorCode.class);
    // Generate documents
    DocumentHelper.generateDocument();
Author:
渔民小镇
See Also:
date:
2024-07-05

  • Method Details

    • setGenerateDoc

      public static void setGenerateDoc(boolean generateDoc)
      Enable or disable document generation.
      Parameters:
      generateDoc - false to suppress document generation

    • generateDocument

      public static void generateDocument()
      Trigger document generation (idempotent -- only runs once).

    • addDocumentGenerate

      public static void addDocumentGenerate(DocumentGenerate documentGenerate)
      Register a document generator. Only one instance per type is kept.
      Parameters:
      documentGenerate - the document generator

    • addErrorCodeClass

      public static void addErrorCodeClass(Class<? extends ErrorInformation> clazz)
      Register an error code enum class for documentation.
      Parameters:
      clazz - the error code enum class

    • addBroadcastDocument

      public static void addBroadcastDocument(BroadcastDocument broadcastDocument)
      Register a broadcast document.
      Parameters:
      broadcastDocument - the broadcast document

    • addBroadcastDocument

      public static void addBroadcastDocument(BroadcastDocumentBuilder broadcastDocumentBuilder)
      Register a broadcast document from a builder.
      Parameters:
      broadcastDocumentBuilder - the broadcast document builder

    • ofActionDoc

      public static ActionDoc ofActionDoc(int cmd, Class<?> controllerClazz)
      Obtain or create an ActionDoc for the given command and controller class.
      Parameters:
      cmd - the primary command ID
      controllerClazz - the action controller class
      Returns:
      the existing or newly created ActionDoc, never null

    • getDocumentAccessAuthentication

      public static DocumentAccessAuthentication getDocumentAccessAuthentication()
      Access authentication control for document routes.

    • setDocumentAccessAuthentication

      public static void setDocumentAccessAuthentication(DocumentAccessAuthentication documentAccessAuthentication)
      Access authentication control for document routes.