Package org.apache.pulsar.broker

Class BaseGenerateDocumentation

java.lang.Object

org.apache.pulsar.broker.BaseGenerateDocumentation

public abstract class BaseGenerateDocumentation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseGenerateDocumentation.CategoryComparator

Field Summary

Fields

Modifier and Type	Field	Description
protected Predicate<Field>	isDeprecated
protected Predicate<Field>	isOptional
protected Predicate<Field>	isRequired
protected String	prefix
protected String	suffix

Constructor Summary

Constructors

Constructor	Description
BaseGenerateDocumentation()

Method Summary

Modifier and Type	Method	Description
protected String	generateDocByApiModelProperty(String className, String type, StringBuilder sb)
protected String	generateDocByFieldContext(String className, String type, StringBuilder sb)
protected abstract String	generateDocumentByClassName(String className)
boolean	run(String[] args)
protected void	writeDocListByFieldContext(List<Field> fieldList, StringBuilder sb, Object obj)

Methods inherited from class java.lang.Object

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

Field Details

isRequired

protected Predicate<Field> isRequired

isOptional

protected Predicate<Field> isOptional

isDeprecated

protected Predicate<Field> isDeprecated

prefix

protected String prefix

suffix

protected String suffix

Constructor Details

BaseGenerateDocumentation

public BaseGenerateDocumentation()

Method Details

run

public boolean run(String[] args)
            throws Exception

Throws:

Exception

generateDocumentByClassName

protected abstract String generateDocumentByClassName(String className)
                                               throws Exception

Throws:

Exception

writeDocListByFieldContext

protected void writeDocListByFieldContext(List<Field> fieldList,
 StringBuilder sb,
 Object obj)
                                   throws Exception

Throws:

Exception

generateDocByFieldContext

protected String generateDocByFieldContext(String className,
 String type,
 StringBuilder sb)
                                    throws Exception

Throws:

Exception

generateDocByApiModelProperty

protected String generateDocByApiModelProperty(String className,
 String type,
 StringBuilder sb)
                                        throws Exception

Throws:

Exception