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 and Description
void	write(ConfigurableComponent configurableComponent, java.io.OutputStream streamToWriteTo, boolean includesAdditionalDocumentation)

Method Detail

write

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

Throws:

java.io.IOException