org.wildfly.swarm.plugin.process

Class ConfigurableDocumentationGenerator

java.lang.Object

org.wildfly.swarm.plugin.process.ConfigurableDocumentationGenerator

All Implemented Interfaces:

Function<FractionMetadata,FractionMetadata>

public class ConfigurableDocumentationGenerator
extends Object
implements Function<FractionMetadata,FractionMetadata>

Author:

Bob McWhirter

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.jandex.DotName	ATTRIBUTE_DOCUMENTATION_ANNOTATION
static org.jboss.jandex.DotName	CONFIGURABLE_ANNOTATION
static org.jboss.jandex.DotName	FRACTION_CLASS
static org.jboss.jandex.DotName	RESOURCE_DOCUMENTATION_ANNOTATION
static org.jboss.jandex.DotName	SINGLETON_RESOURCE_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
ConfigurableDocumentationGenerator(org.apache.maven.plugin.logging.Log log, org.apache.maven.project.MavenProject project, File classesDir)

Method Summary

Modifier and Type	Method and Description
FractionMetadata	apply(FractionMetadata meta)
protected org.jboss.jandex.IndexView	buildIndex(org.jboss.jandex.IndexView ownIndex)
protected org.jboss.jandex.IndexView	loadDependentIndexes()
protected org.jboss.jandex.IndexView	loadDependentIndexFromArchive(File archive)
protected org.jboss.jandex.IndexView	loadIndex(org.apache.maven.artifact.Artifact dep)
protected org.jboss.jandex.IndexView	loadIndex(InputStream in)
protected org.jboss.jandex.IndexView	loadOwnIndex()
protected void	process(org.jboss.jandex.IndexView ownIndex, org.jboss.jandex.IndexView totalIndex)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

FRACTION_CLASS

public static final org.jboss.jandex.DotName FRACTION_CLASS

CONFIGURABLE_ANNOTATION

public static final org.jboss.jandex.DotName CONFIGURABLE_ANNOTATION

SINGLETON_RESOURCE_ANNOTATION

public static final org.jboss.jandex.DotName SINGLETON_RESOURCE_ANNOTATION

ATTRIBUTE_DOCUMENTATION_ANNOTATION

public static final org.jboss.jandex.DotName ATTRIBUTE_DOCUMENTATION_ANNOTATION

RESOURCE_DOCUMENTATION_ANNOTATION

public static final org.jboss.jandex.DotName RESOURCE_DOCUMENTATION_ANNOTATION

Constructor Detail

ConfigurableDocumentationGenerator

public ConfigurableDocumentationGenerator(org.apache.maven.plugin.logging.Log log,
                                          org.apache.maven.project.MavenProject project,
                                          File classesDir)

Method Detail

apply

public FractionMetadata apply(FractionMetadata meta)

Specified by:

apply in interface Function<FractionMetadata,FractionMetadata>

buildIndex

protected org.jboss.jandex.IndexView buildIndex(org.jboss.jandex.IndexView ownIndex)

loadOwnIndex

protected org.jboss.jandex.IndexView loadOwnIndex()

loadDependentIndexes

protected org.jboss.jandex.IndexView loadDependentIndexes()

loadIndex

protected org.jboss.jandex.IndexView loadIndex(org.apache.maven.artifact.Artifact dep)
                                        throws IOException

Throws:

IOException

loadDependentIndexFromArchive

protected org.jboss.jandex.IndexView loadDependentIndexFromArchive(File archive)
                                                            throws IOException

Throws:

IOException

loadIndex

protected org.jboss.jandex.IndexView loadIndex(InputStream in)
                                        throws IOException

Throws:

IOException

process

protected void process(org.jboss.jandex.IndexView ownIndex,
                       org.jboss.jandex.IndexView totalIndex)