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!

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentationWriter()

Method Summary

Modifier and Type	Method and Description
protected String	getDescription(ConfigurableComponent component)
protected List<DynamicProperty>	getDynamicProperties(ConfigurableComponent configurableComponent)
private DynamicRelationship	getDynamicRelationship(Processor processor)
protected ExtensionType	getExtensionType(ConfigurableComponent component)
private InputRequirement.Requirement	getInputRequirement(ConfigurableComponent component)
private List<ReadsAttribute>	getReadsAttributes(Processor processor)
private List<SystemResourceConsideration>	getSystemResourceConsiderations(ConfigurableComponent component)
protected List<String>	getTags(ConfigurableComponent component)
private List<WritesAttribute>	getWritesAttributes(Processor processor)
void	initialize(ConfigurableComponent component) Calls initialize on the component.
protected void	initialize(ControllerService service)
protected void	initialize(Processor processor)
protected void	initialize(ReportingTask reportingTask)
void	write(ConfigurableComponent component) Write the documentation for the given component.
void	write(ConfigurableComponent component, Collection<ServiceAPI> providedServices, Map<String,ServiceAPI> propertyServices) Writes the documentation for the given component.
protected void	writeBody(ConfigurableComponent component, Map<String,ServiceAPI> propertyServices)
protected abstract void	writeDeprecationNotice(DeprecationNotice deprecationNotice)
protected abstract void	writeDescription(String description)
protected abstract void	writeDynamicProperties(List<DynamicProperty> dynamicProperties)
protected abstract void	writeDynamicRelationship(DynamicRelationship dynamicRelationship)
protected abstract void	writeExtensionName(String extensionName)
protected abstract void	writeExtensionType(ExtensionType extensionType)
protected abstract void	writeFooter(ConfigurableComponent component)
protected abstract void	writeHeader(ConfigurableComponent component)
protected abstract void	writeInputRequirementInfo(InputRequirement.Requirement requirement)
protected abstract void	writeProperties(List<PropertyDescriptor> properties, Map<String,ServiceAPI> propertyServices)
protected abstract void	writeProvidedServices(Collection<ServiceAPI> providedServices)
protected abstract void	writeReadsAttributes(List<ReadsAttribute> attributes)
protected abstract void	writeRelationships(Set<Relationship> relationships)
protected abstract void	writeRestrictedInfo(Restricted restricted)
protected abstract void	writeSeeAlso(SeeAlso seeAlso)
protected abstract void	writeStatefulInfo(Stateful stateful)
protected abstract void	writeSystemResourceConsiderationInfo(List<SystemResourceConsideration> considerations)
protected abstract void	writeTags(List<String> tags)
protected abstract void	writeWritesAttributes(List<WritesAttribute> attributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocumentationWriter

public AbstractDocumentationWriter()

Method Detail

initialize

public void initialize(ConfigurableComponent component)

Description copied from interface: ExtensionDocumentationWriter

Calls initialize on the component. Must be called before calling any write methods.

Specified by:

initialize in interface ExtensionDocumentationWriter

Parameters:

component - the component to initialize

initialize

protected void initialize(Processor processor)

initialize

protected void initialize(ControllerService service)
                   throws InitializationException

Throws:

InitializationException

initialize

protected void initialize(ReportingTask reportingTask)
                   throws InitializationException

Throws:

InitializationException

write

public final void write(ConfigurableComponent component)
                 throws IOException

Description copied from interface: ExtensionDocumentationWriter

Write the documentation for the given component.

Specified by:

write in interface ExtensionDocumentationWriter

Parameters:

component - the component to document

Throws:

IOException - if an error occurs writing the documentation

write

public final void write(ConfigurableComponent component,
                        Collection<ServiceAPI> providedServices,
                        Map<String,ServiceAPI> propertyServices)
                 throws IOException

Description copied from interface: ExtensionDocumentationWriter

Writes the documentation for the given component.

Specified by:

write in interface ExtensionDocumentationWriter

Parameters:

component - the component to document

providedServices - the service APIs implemented by the component

propertyServices - the service APIs required by the property descriptors of the component

Throws:

IOException - if an error occurs writing the documentation

writeBody

protected void writeBody(ConfigurableComponent component,
                         Map<String,ServiceAPI> propertyServices)
                  throws IOException

Throws:

IOException

getDescription

protected String getDescription(ConfigurableComponent component)

getTags

protected List<String> getTags(ConfigurableComponent component)

getDynamicProperties

protected List<DynamicProperty> getDynamicProperties(ConfigurableComponent configurableComponent)

getDynamicRelationship

private DynamicRelationship getDynamicRelationship(Processor processor)

getReadsAttributes

private List<ReadsAttribute> getReadsAttributes(Processor processor)

getWritesAttributes

private List<WritesAttribute> getWritesAttributes(Processor processor)

getInputRequirement

private InputRequirement.Requirement getInputRequirement(ConfigurableComponent component)

getSystemResourceConsiderations

private List<SystemResourceConsideration> getSystemResourceConsiderations(ConfigurableComponent component)

getExtensionType

protected ExtensionType getExtensionType(ConfigurableComponent component)

writeHeader

protected abstract void writeHeader(ConfigurableComponent component)
                             throws IOException

Throws:

IOException

writeExtensionName

protected abstract void writeExtensionName(String extensionName)
                                    throws IOException

Throws:

IOException

writeExtensionType

protected abstract void writeExtensionType(ExtensionType extensionType)
                                    throws IOException

Throws:

IOException

writeDeprecationNotice

protected abstract void writeDeprecationNotice(DeprecationNotice deprecationNotice)
                                        throws IOException

Throws:

IOException

writeDescription

protected abstract void writeDescription(String description)
                                  throws IOException

Throws:

IOException

writeTags

protected abstract void writeTags(List<String> tags)
                           throws IOException

Throws:

IOException

writeProperties

protected abstract void writeProperties(List<PropertyDescriptor> properties,
                                        Map<String,ServiceAPI> propertyServices)
                                 throws IOException

Throws:

IOException

writeDynamicProperties

protected abstract void writeDynamicProperties(List<DynamicProperty> dynamicProperties)
                                        throws IOException

Throws:

IOException

writeStatefulInfo

protected abstract void writeStatefulInfo(Stateful stateful)
                                   throws IOException

Throws:

IOException

writeRestrictedInfo

protected abstract void writeRestrictedInfo(Restricted restricted)
                                     throws IOException

Throws:

IOException

writeInputRequirementInfo

protected abstract void writeInputRequirementInfo(InputRequirement.Requirement requirement)
                                           throws IOException

Throws:

IOException

writeSystemResourceConsiderationInfo

protected abstract void writeSystemResourceConsiderationInfo(List<SystemResourceConsideration> considerations)
                                                      throws IOException

Throws:

IOException

writeSeeAlso

protected abstract void writeSeeAlso(SeeAlso seeAlso)
                              throws IOException

Throws:

IOException

writeRelationships

protected abstract void writeRelationships(Set<Relationship> relationships)
                                    throws IOException

Throws:

IOException

writeDynamicRelationship

protected abstract void writeDynamicRelationship(DynamicRelationship dynamicRelationship)
                                          throws IOException

Throws:

IOException

writeReadsAttributes

protected abstract void writeReadsAttributes(List<ReadsAttribute> attributes)
                                      throws IOException

Throws:

IOException

writeWritesAttributes

protected abstract void writeWritesAttributes(List<WritesAttribute> attributes)
                                       throws IOException

Throws:

IOException

writeProvidedServices

protected abstract void writeProvidedServices(Collection<ServiceAPI> providedServices)
                                       throws IOException

Throws:

IOException

writeFooter

protected abstract void writeFooter(ConfigurableComponent component)
                             throws IOException

Throws:

IOException