Class BroadcastDocumentBuilder

java.lang.Object
com.iohao.net.framework.core.doc.BroadcastDocumentBuilder
public class BroadcastDocumentBuilder extends Object
Builder for constructing BroadcastDocument instances that describe server-push routes, their data types, and method metadata.
Since:
21.11
Author:
渔民小镇
date:
2024-07-05

  • Method Details

    • setDataClassList

      public BroadcastDocumentBuilder setDataClassList(Class<?> dataClass)
      Set the broadcast data type as a List of the given class.
      Parameters:
      dataClass - the element type of the list
      Returns:
      this builder

    • setDataClassList

      public BroadcastDocumentBuilder setDataClassList(Class<?> dataClass, String dataDescription)
      Set the broadcast data type as a List with an optional description.
      Parameters:
      dataClass - the element type of the list
      dataDescription - optional description of the data
      Returns:
      this builder

    • setDataClass

      public BroadcastDocumentBuilder setDataClass(Class<?> dataClass)
      Set the broadcast data type.
      Parameters:
      dataClass - the data type class
      Returns:
      this builder

    • setDataClass

      public BroadcastDocumentBuilder setDataClass(Class<?> dataClass, String dataDescription)
      Set the broadcast data type with an optional description.
      Parameters:
      dataClass - the data type class
      dataDescription - optional description of the data
      Returns:
      this builder

    • build

      public BroadcastDocument build()
      Build the broadcast document.
      Returns:
      the constructed BroadcastDocument

    • buildToDocument

      public void buildToDocument()
      Build the broadcast document and register it with DocumentHelper.

    • setDataDescription

      public BroadcastDocumentBuilder setDataDescription(String dataDescription)
      Description of the broadcast data parameter.
      Returns:
      this.

    • setMethodName

      public BroadcastDocumentBuilder setMethodName(String methodName)
      Broadcast method name, used only during client code generation.
      Returns:
      this.

    • setMethodDescription

      public BroadcastDocumentBuilder setMethodDescription(String methodDescription)
      Broadcast (push) description.
      Returns:
      this.