Package org.apache.nifi.documentation
Interface ExtensionDocumentationWriter
- All Known Implementing Classes:
AbstractDocumentationWriter
,XmlDocumentationWriter
public interface ExtensionDocumentationWriter
Generates documentation for an instance of a ConfigurableComponent.
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!
-
Method Summary
Modifier and TypeMethodDescriptionvoid
initialize
(ConfigurableComponent component) Calls initialize on the component.void
write
(ConfigurableComponent component) Write the documentation for the given component.void
write
(ConfigurableComponent component, Collection<ServiceAPI> provideServices, Map<String, ServiceAPI> propertyServiceAPIs) Writes the documentation for the given component.
-
Method Details
-
initialize
Calls initialize on the component. Must be called before calling any write methods.- Parameters:
component
- the component to initialize
-
write
Write the documentation for the given component.- Parameters:
component
- the component to document- Throws:
IOException
- if an error occurs writing the documentation
-
write
void write(ConfigurableComponent component, Collection<ServiceAPI> provideServices, Map<String, ServiceAPI> propertyServiceAPIs) throws IOExceptionWrites the documentation for the given component.- Parameters:
component
- the component to documentprovideServices
- the service APIs implemented by the componentpropertyServiceAPIs
- the service APIs required by the property descriptors of the component- Throws:
IOException
- if an error occurs writing the documentation
-