Package org.apache.pulsar.docs.tools

Class BaseGenerateDocumentation

java.lang.Object

org.apache.pulsar.docs.tools.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>	isOptionalApiModel
protected Predicate<Field>	isRequiredApiModel

Constructor Summary

Constructors

Constructor	Description
BaseGenerateDocumentation()

Method Summary

Modifier and Type	Method	Description
protected String	generateDocByApiModelProperty(String className, String type)
protected String	generateDocByFieldContext(String className, String type)
protected abstract String	generateDocumentByClassName(String className)
boolean	run(String[] args)
protected void	writeDocListByApiModel(List<Field> fieldList, StringBuilder sb, Object obj)
protected void	writeDocListByFieldContext(List<org.apache.commons.lang3.tuple.Pair<Field,org.apache.pulsar.docs.tools.BaseGenerateDocumentation.FieldContextWrapper>> 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

isRequiredApiModel

protected Predicate<Field> isRequiredApiModel

isOptionalApiModel

protected Predicate<Field> isOptionalApiModel

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<org.apache.commons.lang3.tuple.Pair<Field,org.apache.pulsar.docs.tools.BaseGenerateDocumentation.FieldContextWrapper>> fieldList,
 StringBuilder sb,
 Object obj)
                                   throws Exception

Throws:

Exception

writeDocListByApiModel

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

Throws:

Exception

generateDocByFieldContext

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

Throws:

Exception

generateDocByApiModelProperty

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

Throws:

Exception