com.github.houbb.markdown.toc.core.impl

类 AtxMarkdownToc

java.lang.Object

com.github.houbb.markdown.toc.core.impl.AtxMarkdownToc

所有已实现的接口:

MarkdownToc

@API(status=MAINTAINED,
     since="1.0.0")
public class AtxMarkdownToc
extends Object
implements MarkdownToc

# 的标题形式

从以下版本开始:

1.0.0, 2018/01/30

版本:

1.0.0

作者:

bbhou

构造器概要

构造器

构造器和说明
AtxMarkdownToc()

方法概要

限定符和类型	方法和说明
AtxMarkdownToc	charset(String charset) 设置编码
List<TocGen>	genTocDir(String dirPath) 生成指定目录下的所有 markdown 文件 toc
TocGen	genTocFile(String filePath) 生成单个文件的 toc
static AtxMarkdownToc	newInstance() 创建一个实例
AtxMarkdownToc	order(boolean order) 设置是否设置编号
AtxMarkdownToc	subTree(boolean subTree) 设置是否递归 1.
AtxMarkdownToc	write(boolean write) 设置是否写入到文件中

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

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

构造器详细资料

AtxMarkdownToc

public AtxMarkdownToc()

方法详细资料

genTocFile

public TocGen genTocFile(String filePath)

从接口复制的说明: MarkdownToc

生成单个文件的 toc

指定者:

genTocFile 在接口中 MarkdownToc

参数:

filePath - 文件路径

返回:

生成的结果信息

genTocDir

public List<TocGen> genTocDir(String dirPath)

从接口复制的说明: MarkdownToc

生成指定目录下的所有 markdown 文件 toc

指定者:

genTocDir 在接口中 MarkdownToc

参数:

dirPath - 文件夹路径

返回:

生成的结果信息列表

newInstance

public static AtxMarkdownToc newInstance()

创建一个实例

返回:

新的实例

charset

public AtxMarkdownToc charset(String charset)

设置编码

参数:

charset - 编码

返回:

this

subTree

public AtxMarkdownToc subTree(boolean subTree)

设置是否递归 1. 注意：只有在文件夹模式下生效

参数:

subTree - 是否包含子文件夹元素

返回:

this

write

public AtxMarkdownToc write(boolean write)

设置是否写入到文件中

参数:

write - 写入文件

返回:

this

order

public AtxMarkdownToc order(boolean order)

设置是否设置编号

参数:

order - 编号

返回:

this