org.coodex.concrete.apitools

Class AbstractRender

java.lang.Object

org.coodex.concrete.apitools.AbstractRender

All Implemented Interfaces:

ConcreteAPIRender

Direct Known Subclasses:

AbstractAngularRender, AbstractMarkdownRender, JQueryDocRender, JQueryPromisesCodeRender, JQueryWebSocketCodeRender, ReactiveStreamsRender, ServiceDocRender

public abstract class AbstractRender
extends Object
implements ConcreteAPIRender

Created by davidoff shen on 2016-12-04.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FS

Constructor Summary

Constructors

Constructor and Description
AbstractRender()

Method Summary

Modifier and Type	Method and Description
protected void	copyTo(String resourceName, String path)
protected boolean	exists(String file)
protected String	getRenderDesc()
protected abstract String	getRenderName()
protected abstract String	getTemplatePath()
boolean	isAccept(String desc) 例如： 服务提供类型：JaxRS 类型：code, doc 使用者：backend, jquery, angularjs, angualr2, java, c#等 文档化格式：gitbook, asciidoctor, markdown
void	setRoot(String rootPath)
void	writeTo(String filePath, String templateName, Map<String,Object> map)
void	writeTo(String filePath, String templateName, String pojoKey, Object value)
void	writeTo(String filePath, String templateName, String pojoKey, Object value, Object toolKit)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.coodex.concrete.apitools.ConcreteAPIRender

writeTo

Field Detail

FS

protected static final String FS

Constructor Detail

AbstractRender

public AbstractRender()

Method Detail

getRenderDesc

protected String getRenderDesc()

setRoot

public void setRoot(String rootPath)

Specified by:

setRoot in interface ConcreteAPIRender

getTemplatePath

protected abstract String getTemplatePath()

getRenderName

protected abstract String getRenderName()

isAccept

public boolean isAccept(String desc)

Description copied from interface: ConcreteAPIRender

例如：
   服务提供类型：JaxRS
   类型：code, doc
   使用者：backend, jquery, angularjs, angualr2, java, c#等
   文档化格式：gitbook, asciidoctor, markdown

Specified by:

isAccept in interface ConcreteAPIRender

Parameters:

desc - 服务提供类型.类型.使用者.文档化格式.版本

Returns:

writeTo

public void writeTo(String filePath,
                    String templateName,
                    String pojoKey,
                    Object value)
             throws IOException

Throws:

IOException

writeTo

public void writeTo(String filePath,
                    String templateName,
                    String pojoKey,
                    Object value,
                    Object toolKit)
             throws IOException

Throws:

IOException

writeTo

public void writeTo(String filePath,
                    String templateName,
                    Map<String,Object> map)
             throws IOException

Throws:

IOException

exists

protected boolean exists(String file)

copyTo

protected void copyTo(String resourceName,
                      String path)
               throws IOException

Throws:

IOException