org.testingisdocumenting.znai.java.extensions

Class JavaIncludePluginBase

java.lang.Object

org.testingisdocumenting.znai.java.extensions.JavaIncludePluginBase

All Implemented Interfaces:

IncludePlugin, Plugin

Direct Known Subclasses:

JavaDocIncludePlugin, JavaDocParamsIncludePlugin, JavaEnumEntriesIncludePlugin, JavaIncludePlugin

public abstract class JavaIncludePluginBase
extends Object
implements IncludePlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected CodeReferencesFeature	codeReferencesFeature
protected ComponentsRegistry	componentsRegistry
protected List<String>	entries
protected String	entry
protected PluginFeatureList	features
protected Path	fullPath
protected Path	markupPath
protected String	path
protected PluginParams	pluginParams

Constructor Summary

Constructors

Constructor and Description
JavaIncludePluginBase()

Method Summary

Modifier and Type	Method and Description
Stream<AuxiliaryFile>	auxiliaryFiles(ComponentsRegistry componentsRegistry)
protected List<Map<String,Object>>	javaDocTextToDocElements(String html)
PluginResult	process(ComponentsRegistry componentsRegistry, ParserHandler parserHandler, Path markupPath, PluginParams pluginParams)
abstract org.testingisdocumenting.znai.java.extensions.JavaIncludeResult	process(JavaCode javaCode)
SearchText	textForSearch()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testingisdocumenting.znai.extensions.include.IncludePlugin

create

Methods inherited from interface org.testingisdocumenting.znai.extensions.Plugin

id

Field Detail

path

protected String path

fullPath

protected Path fullPath

componentsRegistry

protected ComponentsRegistry componentsRegistry

markupPath

protected Path markupPath

pluginParams

protected PluginParams pluginParams

entry

protected String entry

entries

protected List<String> entries

features

protected PluginFeatureList features

codeReferencesFeature

protected CodeReferencesFeature codeReferencesFeature

Constructor Detail

JavaIncludePluginBase

public JavaIncludePluginBase()

Method Detail

process

public PluginResult process(ComponentsRegistry componentsRegistry,
                            ParserHandler parserHandler,
                            Path markupPath,
                            PluginParams pluginParams)

Specified by:

process in interface IncludePlugin

process

public abstract org.testingisdocumenting.znai.java.extensions.JavaIncludeResult process(JavaCode javaCode)

auxiliaryFiles

public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistry)

Specified by:

auxiliaryFiles in interface Plugin

textForSearch

public SearchText textForSearch()

Specified by:

textForSearch in interface Plugin

javaDocTextToDocElements

protected List<Map<String,Object>> javaDocTextToDocElements(String html)