Package org.apache.nifi.documentation

Interface DocumentationWriter

All Known Implementing Classes:

HtmlDocumentationWriter, HtmlProcessorDocumentationWriter

public interface DocumentationWriter

Generates documentation for an instance of a ConfigurableComponent

Method Summary

Modifier and Type	Method	Description
void	write(ConfigurableComponent configurableComponent, OutputStream streamToWriteTo, boolean includesAdditionalDocumentation)

Method Details

write

void write(ConfigurableComponent configurableComponent,
 OutputStream streamToWriteTo,
 boolean includesAdditionalDocumentation)
    throws IOException

Throws:

IOException