org.apache.nifi.documentation

Class DocGenerator

java.lang.Object

org.apache.nifi.documentation.DocGenerator

public class DocGenerator
extends Object

Enumerate available Components from Extension Manager and generate HTML documentation

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
DocGenerator()

Method Summary

Modifier and Type	Method and Description
private static void	document(ExtensionManager extensionManager, File componentDocsDir, Class<? extends ConfigurableComponent> componentClass, BundleCoordinate bundleCoordinate) Generates the documentation for a particular configurable component.
static void	documentConfigurableComponent(Set<ExtensionDefinition> extensionDefinitions, File explodedNiFiDocsDir, ExtensionManager extensionManager) Documents a type of configurable component.
static void	generate(NiFiProperties properties, ExtensionManager extensionManager, ExtensionMapping extensionMapping) Generates documentation into the work/docs dir specified by NiFiProperties.
private static DocumentationWriter	getDocumentWriter(ExtensionManager extensionManager, Class<? extends ConfigurableComponent> componentClass)
private static boolean	hasAdditionalInfo(File directory)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

Constructor Detail

DocGenerator

public DocGenerator()

Method Detail

generate

public static void generate(NiFiProperties properties,
                            ExtensionManager extensionManager,
                            ExtensionMapping extensionMapping)

Generates documentation into the work/docs dir specified by NiFiProperties.

Parameters:

properties - to lookup nifi properties

extensionMapping - extension mapping

documentConfigurableComponent

public static void documentConfigurableComponent(Set<ExtensionDefinition> extensionDefinitions,
                                                 File explodedNiFiDocsDir,
                                                 ExtensionManager extensionManager)

Documents a type of configurable component.

Parameters:

extensionDefinitions - definitions of the extensions to document

explodedNiFiDocsDir - base directory of component documentation

document

private static void document(ExtensionManager extensionManager,
                             File componentDocsDir,
                             Class<? extends ConfigurableComponent> componentClass,
                             BundleCoordinate bundleCoordinate)
                      throws IOException

Generates the documentation for a particular configurable component. Will check to see if an "additionalDetails.html" file exists and will link that from the generated documentation.

Parameters:

componentDocsDir - the component documentation directory

componentClass - the class to document

Throws:

IOException - ioe

getDocumentWriter

private static DocumentationWriter getDocumentWriter(ExtensionManager extensionManager,
                                                     Class<? extends ConfigurableComponent> componentClass)

hasAdditionalInfo

private static boolean hasAdditionalInfo(File directory)