Package org.apache.nifi.documentation

Class AbstractDocumentationWriter

java.lang.Object
org.apache.nifi.documentation.AbstractDocumentationWriter
All Implemented Interfaces:
ExtensionDocumentationWriter
Direct Known Subclasses:
XmlDocumentationWriter
public abstract class AbstractDocumentationWriter extends Object implements ExtensionDocumentationWriter
Base class for DocumentationWriter that simplifies iterating over all information for a component, creating a separate method for each, to ensure that implementations properly override all methods and therefore properly account for all information about a component. Please note that while this class lives within the nifi-api, it is provided primarily as a means for documentation components within the NiFi NAR Maven Plugin. Its home is the nifi-api, however, because the API is needed in order to extract the relevant information and the NAR Maven Plugin cannot have a direct dependency on nifi-api (doing so would cause a circular dependency). By having this homed within the nifi-api, the Maven plugin is able to discover the class dynamically and invoke the one or two methods necessary to create the documentation. This is a new capability in 1.9.0 in preparation for the Extension Registry and therefore, you should NOTE WELL: At this time, while this class is part of nifi-api, it is still evolving and may change in a non-backward-compatible manner or even be removed from one incremental release to the next. Use at your own risk!