程序包 org.coodex.concrete.apitools

类 AbstractRenderer<M extends org.coodex.concrete.common.modules.AbstractModule<?>>

java.lang.Object

org.coodex.concrete.apitools.AbstractRenderer<M>

所有已实现的接口:

ConcreteAPIRenderer<M>

直接已知子类:

AbstractAngularRenderer, AbstractServiceDocRenderer, AxiosCodeRenderer, JQueryDocRenderer, JQueryPromisesCodeRenderer, JQueryWebSocketCodeRenderer, ReactiveStreamsRenderer

public abstract class AbstractRenderer<M extends org.coodex.concrete.common.modules.AbstractModule<?>>
extends Object
implements ConcreteAPIRenderer<M>

Created by davidoff shen on 2016-12-04.

字段概要

字段

修饰符和类型	字段	说明
protected static final String	FS

构造器概要

构造器

构造器	说明
AbstractRenderer()

方法概要

修饰符和类型	方法	说明
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
protected Map<String,Object>	merge(Map<String,Object> map)
void	setExt(Map<String,Object> ext)
void	setRoot(String rootPath)
void	writeTo(String filePath, String content)
void	writeTo(String filePath, String templateName, String pojoKey, Object value)
void	writeTo(String filePath, String templateName, String pojoKey, Object value, Object toolKit)
void	writeTo(String filePath, String templateName, Map<String,Object> map)

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.coodex.concrete.apitools.ConcreteAPIRenderer

render

字段详细资料

FS

protected static final String FS

构造器详细资料

AbstractRenderer

public AbstractRenderer()

方法详细资料

getRenderDesc

protected String getRenderDesc()

setRoot

public void setRoot(String rootPath)

指定者:

setRoot 在接口中 ConcreteAPIRenderer<M extends org.coodex.concrete.common.modules.AbstractModule<?>>

getTemplatePath

protected abstract String getTemplatePath()

getRenderName

protected abstract String getRenderName()

isAccept

public boolean isAccept(String desc)

从接口复制的说明: ConcreteAPIRenderer

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

指定者:

isAccept 在接口中 ConcreteAPIRenderer<M extends org.coodex.concrete.common.modules.AbstractModule<?>>

参数:

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

返回:

是否受理desc

writeTo

public void writeTo(String filePath,
 String content)
             throws IOException

抛出:

IOException

writeTo

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

抛出:

IOException

writeTo

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

抛出:

IOException

merge

protected Map<String,Object> merge(Map<String,Object> map)

writeTo

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

抛出:

IOException

exists

protected boolean exists(String file)

copyTo

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

抛出:

IOException

setExt

public void setExt(Map<String,Object> ext)

指定者:

setExt 在接口中 ConcreteAPIRenderer<M extends org.coodex.concrete.common.modules.AbstractModule<?>>