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 Summary

Modifier and Type	Method	Description
BroadcastDocument	build()	Build the broadcast document.
void	buildToDocument()	Build the broadcast document and register it with DocumentHelper.
BroadcastDocumentBuilder	setDataClass(Class<?> dataClass)	Set the broadcast data type.
BroadcastDocumentBuilder	setDataClass(Class<?> dataClass, String dataDescription)	Set the broadcast data type with an optional description.
BroadcastDocumentBuilder	setDataClassList(Class<?> dataClass)	Set the broadcast data type as a List of the given class.
BroadcastDocumentBuilder	setDataClassList(Class<?> dataClass, String dataDescription)	Set the broadcast data type as a List with an optional description.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.