org.wildfly.swarm.plugin.process.configurable

Class DocumentationGatherer

java.lang.Object

org.wildfly.swarm.plugin.process.configurable.DocumentationGatherer

Direct Known Subclasses:

AnnotationDocumentationGatherer, ResourceDocumentationGatherer, SubresourcesDocumentationGatherer

public abstract class DocumentationGatherer
extends Object

Author:

Bob McWhirter

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.jandex.IndexView	index
protected DocumentationRegistry	registry

Constructor Summary

Constructors

Constructor and Description
DocumentationGatherer(org.apache.maven.plugin.logging.Log log, DocumentationRegistry registry, org.jboss.jandex.IndexView index)

Method Summary

Modifier and Type	Method and Description
protected void	addDocumentation(String key, String docs)
protected static String	dashize(String name)
abstract void	gather()
protected org.jboss.jandex.ClassInfo	getClassByName(org.jboss.jandex.DotName name)
protected static String	getDocumentation(org.jboss.jandex.FieldInfo field)
protected org.apache.maven.plugin.logging.Log	getLog()
protected static boolean	isMarkedAsConfigurable(org.jboss.jandex.FieldInfo field)
protected static boolean	isMarkedAsDocumented(org.jboss.jandex.FieldInfo field)
protected static boolean	isSingletonResource(org.jboss.jandex.FieldInfo field)
protected static boolean	isSubresources(org.jboss.jandex.FieldInfo field)
protected static String	nameFor(org.jboss.jandex.ClassInfo fraction)
protected static String	nameFor(org.jboss.jandex.FieldInfo field)

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected final DocumentationRegistry registry

index

protected final org.jboss.jandex.IndexView index

Constructor Detail

DocumentationGatherer

public DocumentationGatherer(org.apache.maven.plugin.logging.Log log,
                             DocumentationRegistry registry,
                             org.jboss.jandex.IndexView index)

Method Detail

getLog

protected org.apache.maven.plugin.logging.Log getLog()

addDocumentation

protected void addDocumentation(String key,
                                String docs)

getClassByName

protected org.jboss.jandex.ClassInfo getClassByName(org.jboss.jandex.DotName name)

dashize

protected static String dashize(String name)

isMarkedAsConfigurable

protected static boolean isMarkedAsConfigurable(org.jboss.jandex.FieldInfo field)

isMarkedAsDocumented

protected static boolean isMarkedAsDocumented(org.jboss.jandex.FieldInfo field)

isSingletonResource

protected static boolean isSingletonResource(org.jboss.jandex.FieldInfo field)

isSubresources

protected static boolean isSubresources(org.jboss.jandex.FieldInfo field)

getDocumentation

protected static String getDocumentation(org.jboss.jandex.FieldInfo field)

nameFor

protected static String nameFor(org.jboss.jandex.FieldInfo field)

nameFor

protected static String nameFor(org.jboss.jandex.ClassInfo fraction)

gather

public abstract void gather()