Index

A C D E G H I J L O W
All Classes and Interfaces|All Packages|Constant Field Values

A

ADDITIONAL_DETAILS_HTML - Static variable in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

The filename where additional user specified information may be stored.

C

containsExpressionLanguage(ConfigurableComponent) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Indicates whether or not the component contains at least one property that supports Expression Language.

D

defaultIfBlank(String, String) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

DocGenerator - Class in org.apache.nifi.documentation

Enumerate available Components from Extension Manager and generate HTML documentation

DocGenerator() - Constructor for class org.apache.nifi.documentation.DocGenerator

document(ExtensionManager, File, Class<? extends ConfigurableComponent>, BundleCoordinate) - Static method in class org.apache.nifi.documentation.DocGenerator

Generates the documentation for a particular configurable component.

DocumentationWriter - Interface in org.apache.nifi.documentation

Generates documentation for an instance of a ConfigurableComponent

documentConfigurableComponent(Set<ExtensionDefinition>, File, ExtensionManager) - Static method in class org.apache.nifi.documentation.DocGenerator

Documents a type of configurable component.

E

extensionManager - Variable in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

G

generate(NiFiProperties, ExtensionManager, ExtensionMapping) - Static method in class org.apache.nifi.documentation.DocGenerator

Generates documentation into the work/docs dir specified by NiFiProperties.

getDefaultValue(PropertyDescriptor) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

getDescription(ConfigurableComponent) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Gets a description of the ConfigurableComponent using the CapabilityDescription annotation.

getDocumentWriter(ExtensionManager, Class<? extends ConfigurableComponent>) - Static method in class org.apache.nifi.documentation.DocGenerator

getDynamicProperties(ConfigurableComponent) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

getDynamicRelationships(Processor) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

getReadsAttributes(Processor) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Collects the attributes that a processor is reading from.

getTitle(ConfigurableComponent) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Gets the class name of the component.

getWritesAttributes(Processor) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Collects the attributes that a processor is writing to.

H

handleReadsAttributes(XMLStreamWriter, Processor) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Writes out just the attributes that are being read in a table form.

handleWritesAttributes(XMLStreamWriter, Processor) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Writes out just the attributes that are being written to in a table form.

hasAdditionalInfo(File) - Static method in class org.apache.nifi.documentation.DocGenerator

HtmlDocumentationWriter - Class in org.apache.nifi.documentation.html

Generates HTML documentation for a ConfigurableComponent.

HtmlDocumentationWriter(ExtensionManager) - Constructor for class org.apache.nifi.documentation.html.HtmlDocumentationWriter

HtmlProcessorDocumentationWriter - Class in org.apache.nifi.documentation.html

Writes documentation specific for a Processor.

HtmlProcessorDocumentationWriter(ExtensionManager) - Constructor for class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

I

iterateAndLinkComponents(XMLStreamWriter, Class<? extends ConfigurableComponent>[], String[], String, String) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes a link to another configurable component

J

join(Object[]) - Static method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

L

logger - Static variable in class org.apache.nifi.documentation.DocGenerator

LOGGER - Static variable in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

lookupControllerServiceImpls(Class<? extends ControllerService>) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Uses the ExtensionManager to discover any ControllerService implementations that implement a specific ControllerService API.

O

org.apache.nifi.documentation - package org.apache.nifi.documentation

org.apache.nifi.documentation.html - package org.apache.nifi.documentation.html

W

write(ConfigurableComponent, OutputStream, boolean) - Method in interface org.apache.nifi.documentation.DocumentationWriter

write(ConfigurableComponent, OutputStream, boolean) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeAdditionalBodyInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

This method may be overridden by sub classes to write additional information to the body of the documentation.

writeAdditionalBodyInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

writeAttributeInfo(Processor, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Writes all the attributes that a processor says it reads and writes

writeBody(ConfigurableComponent, XMLStreamWriter, boolean) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes the body section of the documentation, this consists of the component description, the tags, and the PropertyDescriptors.

writeDeprecationWarning(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes a warning about the deprecation of a component.

writeDescription(ConfigurableComponent, XMLStreamWriter, boolean) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes a description of the configurable component.

writeDynamicProperties(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeDynamicRelationships(Processor, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

writeHead(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes the head portion of the HTML documentation.

writeHeader(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Write the header to be displayed when loaded outside an iframe.

writeInputRequirementInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Add in the documentation information regarding the component whether it accepts an incoming relationship or not.

writeLink(XMLStreamWriter, String, String) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

A helper method to write a link

writeMultiComponentUseCases(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeProperties(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes the PropertyDescriptors out as a table.

writeRelationships(Processor, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

Writes a table describing the relations a processor has.

writeRestrictedInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Write the description of the Restricted annotation if provided in this component.

writeSeeAlso(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes the list of components that may be linked from this component.

writeSimpleElement(XMLStreamWriter, String, String) - Static method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes a begin element, then text, then end element for the element of a users choosing.

writeSimpleElement(XMLStreamWriter, String, String, String) - Static method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes a begin element, an id attribute(if specified), then text, then end element for element of the users choosing.

writeStatefulInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Write the description of the Stateful annotation if provided in this component.

writeSupportsSensitiveDynamicProperties(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeSystemResourceConsiderationInfo(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Writes all the system resource considerations for this component

writeTags(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeUseCaseConfiguration(String, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeUseCases(ConfigurableComponent, XMLStreamWriter) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeValidValueDescription(XMLStreamWriter, String) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

writeValidValues(XMLStreamWriter, PropertyDescriptor) - Method in class org.apache.nifi.documentation.html.HtmlDocumentationWriter

Interrogates a PropertyDescriptor to get a list of AllowableValues, if there are none, nothing is written to the stream.

A C D E G H I J L O W
All Classes and Interfaces|All Packages|Constant Field Values