Package org.apache.nifi.documentation.xml

Class XmlDocumentationWriter

java.lang.Object

org.apache.nifi.documentation.AbstractDocumentationWriter

org.apache.nifi.documentation.xml.XmlDocumentationWriter

All Implemented Interfaces:

ExtensionDocumentationWriter

public class XmlDocumentationWriter
extends AbstractDocumentationWriter

XML-based implementation of DocumentationWriter 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!

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	XmlDocumentationWriter.ElementWriter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final XMLStreamWriter	writer

Constructor Summary

Constructors

Constructor	Description
XmlDocumentationWriter(OutputStream out)
XmlDocumentationWriter(XMLStreamWriter writer)

Method Summary

Modifier and Type	Method	Description
private void	writeAllowableValue(AllowableValue allowableValue)
private <T> void	writeArray(String tagName, Collection<T> values, XmlDocumentationWriter.ElementWriter<T> writer)
private void	writeBooleanElement(String name, boolean value)
protected void	writeDefaultSchedule(DefaultSchedule defaultSchedule)
protected void	writeDefaultSettings(DefaultSettings defaultSettings)
private void	writeDependencies(PropertyDescriptor propertyDescriptor)
private void	writeDeprecationNotice(String reason, Set<String> alternatives)
protected void	writeDeprecationNotice(DeprecationNotice deprecationNotice)
protected void	writeDescription(String description)
protected void	writeDynamicProperties(List<DynamicProperty> dynamicProperties)
private void	writeDynamicProperty(DynamicProperty property)
protected void	writeDynamicRelationship(DynamicRelationship dynamicRelationship)
private void	writeEmptyElement(String elementName)
private void	writeEndElement()
protected void	writeExtensionName(String extensionName)
protected void	writeExtensionType(ExtensionType extensionType)
protected void	writeFooter(ConfigurableComponent component)
protected void	writeHeader(ConfigurableComponent component)
protected void	writeInputRequirementInfo(InputRequirement.Requirement requirement)
private void	writeMultiProcessorUseCase(MultiProcessorUseCase useCase)
protected void	writeMultiProcessorUseCases(List<MultiProcessorUseCase> multiProcessorUseCases)
protected void	writePrimaryNodeOnly(PrimaryNodeOnly primaryNodeOnly)
protected void	writeProperties(List<PropertyDescriptor> properties, Map<String,ServiceAPI> propertyServices)
private void	writeProperty(PropertyDescriptor property, Map<String,ServiceAPI> propertyServices)
private void	writeProvidedService(ServiceAPI service)
protected void	writeProvidedServices(Collection<ServiceAPI> providedServices)
private void	writeReadsAttribute(ReadsAttribute attribute)
protected void	writeReadsAttributes(List<ReadsAttribute> attributes)
protected void	writeRelationships(Set<Relationship> relationships)
private void	writeResourceDefinition(ResourceDefinition resourceDefinition)
private void	writeResourceType(ResourceType resourceType)
protected void	writeRestrictedInfo(Restricted restricted)
private void	writeRestriction(Restriction restriction)
protected void	writeSeeAlso(SeeAlso seeAlso)
protected void	writeSideEffectFree(SideEffectFree sideEffectFree)
private void	writeStartElement(String elementName)
protected void	writeStatefulInfo(Stateful stateful)
protected void	writeSupportsBatching(SupportsBatching supportsBatching)
protected void	writeSupportsSensitiveDynamicProperties(SupportsSensitiveDynamicProperties supportsSensitiveDynamicProperties)
private void	writeSystemResourceConsideration(SystemResourceConsideration consideration)
protected void	writeSystemResourceConsiderationInfo(List<SystemResourceConsideration> considerations)
protected void	writeTags(List<String> tags)
private void	writeText(String text)
private void	writeTextArray(String outerTagName, String elementTagName, Collection<String> values)
private <T> void	writeTextArray(String outerTagName, String elementTagName, Collection<T> values, Function<T,String> transform)
private void	writeTextElement(String name, String text)
protected void	writeTriggerSerially(TriggerSerially triggerSerially)
protected void	writeTriggerWhenAnyDestinationAvailable(TriggerWhenAnyDestinationAvailable triggerWhenAnyDestinationAvailable)
protected void	writeTriggerWhenEmpty(TriggerWhenEmpty triggerWhenEmpty)
private void	writeUseCase(UseCase useCase)
private void	writeUseCaseComponent(ProcessorConfiguration processorConfig)
protected void	writeUseCases(List<UseCase> useCases)
private void	writeWritesAttribute(WritesAttribute attribute)
protected void	writeWritesAttributes(List<WritesAttribute> attributes)

Methods inherited from class org.apache.nifi.documentation.AbstractDocumentationWriter

getDescription, getDynamicProperties, getExtensionType, getTags, initialize, initialize, initialize, initialize, initialize, initialize, write, write, writeBody

Methods inherited from class java.lang.Object

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

Field Details

writer

private final XMLStreamWriter writer

Constructor Details

XmlDocumentationWriter

public XmlDocumentationWriter(OutputStream out)
                       throws XMLStreamException

Throws:

XMLStreamException

XmlDocumentationWriter

public XmlDocumentationWriter(XMLStreamWriter writer)

Method Details

writeHeader

protected void writeHeader(ConfigurableComponent component)
                    throws IOException

Specified by:

writeHeader in class AbstractDocumentationWriter

Throws:

IOException

writeExtensionName

protected void writeExtensionName(String extensionName)
                           throws IOException

Specified by:

writeExtensionName in class AbstractDocumentationWriter

Throws:

IOException

writeExtensionType

protected void writeExtensionType(ExtensionType extensionType)
                           throws IOException

Specified by:

writeExtensionType in class AbstractDocumentationWriter

Throws:

IOException

writeDeprecationNotice

protected void writeDeprecationNotice(DeprecationNotice deprecationNotice)
                               throws IOException

Specified by:

writeDeprecationNotice in class AbstractDocumentationWriter

Throws:

IOException

writeDeprecationNotice

private void writeDeprecationNotice(String reason,
 Set<String> alternatives)
                             throws IOException

Throws:

IOException

writeDescription

protected void writeDescription(String description)
                         throws IOException

Specified by:

writeDescription in class AbstractDocumentationWriter

Throws:

IOException

writeTags

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

Specified by:

writeTags in class AbstractDocumentationWriter

Throws:

IOException

writeProperties

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

Specified by:

writeProperties in class AbstractDocumentationWriter

Throws:

IOException

writeProperty

private void writeProperty(PropertyDescriptor property,
 Map<String,ServiceAPI> propertyServices)
                    throws IOException

Throws:

IOException

writeResourceDefinition

private void writeResourceDefinition(ResourceDefinition resourceDefinition)
                              throws IOException

Throws:

IOException

writeResourceType

private void writeResourceType(ResourceType resourceType)
                        throws IOException

Throws:

IOException

writeAllowableValue

private void writeAllowableValue(AllowableValue allowableValue)
                          throws IOException

Throws:

IOException

writeDependencies

private void writeDependencies(PropertyDescriptor propertyDescriptor)
                        throws IOException

Throws:

IOException

writeDynamicProperties

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

Specified by:

writeDynamicProperties in class AbstractDocumentationWriter

Throws:

IOException

writeDynamicProperty

private void writeDynamicProperty(DynamicProperty property)
                           throws IOException

Throws:

IOException

writeStatefulInfo

protected void writeStatefulInfo(Stateful stateful)
                          throws IOException

Specified by:

writeStatefulInfo in class AbstractDocumentationWriter

Throws:

IOException

writeRestrictedInfo

protected void writeRestrictedInfo(Restricted restricted)
                            throws IOException

Specified by:

writeRestrictedInfo in class AbstractDocumentationWriter

Throws:

IOException

writeRestriction

private void writeRestriction(Restriction restriction)
                       throws IOException

Throws:

IOException

writeInputRequirementInfo

protected void writeInputRequirementInfo(InputRequirement.Requirement requirement)
                                  throws IOException

Specified by:

writeInputRequirementInfo in class AbstractDocumentationWriter

Throws:

IOException

writeSystemResourceConsiderationInfo

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

Specified by:

writeSystemResourceConsiderationInfo in class AbstractDocumentationWriter

Throws:

IOException

writeSystemResourceConsideration

private void writeSystemResourceConsideration(SystemResourceConsideration consideration)
                                       throws IOException

Throws:

IOException

writeSeeAlso

protected void writeSeeAlso(SeeAlso seeAlso)
                     throws IOException

Specified by:

writeSeeAlso in class AbstractDocumentationWriter

Throws:

IOException

writeUseCases

protected void writeUseCases(List<UseCase> useCases)
                      throws IOException

Specified by:

writeUseCases in class AbstractDocumentationWriter

Throws:

IOException

writeUseCase

private void writeUseCase(UseCase useCase)
                   throws IOException

Throws:

IOException

writeMultiProcessorUseCases

protected void writeMultiProcessorUseCases(List<MultiProcessorUseCase> multiProcessorUseCases)
                                    throws IOException

Specified by:

writeMultiProcessorUseCases in class AbstractDocumentationWriter

Throws:

IOException

writeMultiProcessorUseCase

private void writeMultiProcessorUseCase(MultiProcessorUseCase useCase)
                                 throws IOException

Throws:

IOException

writeUseCaseComponent

private void writeUseCaseComponent(ProcessorConfiguration processorConfig)
                            throws IOException

Throws:

IOException

writeRelationships

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

Specified by:

writeRelationships in class AbstractDocumentationWriter

Throws:

IOException

writeDynamicRelationship

protected void writeDynamicRelationship(DynamicRelationship dynamicRelationship)
                                 throws IOException

Specified by:

writeDynamicRelationship in class AbstractDocumentationWriter

Throws:

IOException

writeReadsAttributes

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

Specified by:

writeReadsAttributes in class AbstractDocumentationWriter

Throws:

IOException

writeReadsAttribute

private void writeReadsAttribute(ReadsAttribute attribute)
                          throws IOException

Throws:

IOException

writeWritesAttributes

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

Specified by:

writeWritesAttributes in class AbstractDocumentationWriter

Throws:

IOException

writeWritesAttribute

private void writeWritesAttribute(WritesAttribute attribute)
                           throws IOException

Throws:

IOException

writeTriggerSerially

protected void writeTriggerSerially(TriggerSerially triggerSerially)
                             throws IOException

Specified by:

writeTriggerSerially in class AbstractDocumentationWriter

Throws:

IOException

writeTriggerWhenEmpty

protected void writeTriggerWhenEmpty(TriggerWhenEmpty triggerWhenEmpty)
                              throws IOException

Specified by:

writeTriggerWhenEmpty in class AbstractDocumentationWriter

Throws:

IOException

writeTriggerWhenAnyDestinationAvailable

protected void writeTriggerWhenAnyDestinationAvailable(TriggerWhenAnyDestinationAvailable triggerWhenAnyDestinationAvailable)
                                                throws IOException

Specified by:

writeTriggerWhenAnyDestinationAvailable in class AbstractDocumentationWriter

Throws:

IOException

writeSupportsBatching

protected void writeSupportsBatching(SupportsBatching supportsBatching)
                              throws IOException

Specified by:

writeSupportsBatching in class AbstractDocumentationWriter

Throws:

IOException

writeSupportsSensitiveDynamicProperties

protected void writeSupportsSensitiveDynamicProperties(SupportsSensitiveDynamicProperties supportsSensitiveDynamicProperties)
                                                throws IOException

Specified by:

writeSupportsSensitiveDynamicProperties in class AbstractDocumentationWriter

Throws:

IOException

writePrimaryNodeOnly

protected void writePrimaryNodeOnly(PrimaryNodeOnly primaryNodeOnly)
                             throws IOException

Specified by:

writePrimaryNodeOnly in class AbstractDocumentationWriter

Throws:

IOException

writeSideEffectFree

protected void writeSideEffectFree(SideEffectFree sideEffectFree)
                            throws IOException

Specified by:

writeSideEffectFree in class AbstractDocumentationWriter

Throws:

IOException

writeDefaultSchedule

protected void writeDefaultSchedule(DefaultSchedule defaultSchedule)
                             throws IOException

Specified by:

writeDefaultSchedule in class AbstractDocumentationWriter

Throws:

IOException

writeDefaultSettings

protected void writeDefaultSettings(DefaultSettings defaultSettings)
                             throws IOException

Specified by:

writeDefaultSettings in class AbstractDocumentationWriter

Throws:

IOException

writeFooter

protected void writeFooter(ConfigurableComponent component)
                    throws IOException

Specified by:

writeFooter in class AbstractDocumentationWriter

Throws:

IOException

writeProvidedServices

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

Specified by:

writeProvidedServices in class AbstractDocumentationWriter

Throws:

IOException

writeProvidedService

private void writeProvidedService(ServiceAPI service)
                           throws IOException

Throws:

IOException

writeArray

private <T> void writeArray(String tagName,
 Collection<T> values,
 XmlDocumentationWriter.ElementWriter<T> writer)
                     throws IOException

Throws:

IOException

writeTextArray

private void writeTextArray(String outerTagName,
 String elementTagName,
 Collection<String> values)
                     throws IOException

Throws:

IOException

writeTextArray

private <T> void writeTextArray(String outerTagName,
 String elementTagName,
 Collection<T> values,
 Function<T,String> transform)
                         throws IOException

Throws:

IOException

writeText

private void writeText(String text)
                throws IOException

Throws:

IOException

writeEmptyElement

private void writeEmptyElement(String elementName)
                        throws IOException

Throws:

IOException

writeStartElement

private void writeStartElement(String elementName)
                        throws IOException

Throws:

IOException

writeEndElement

private void writeEndElement()
                      throws IOException

Throws:

IOException

writeTextElement

private void writeTextElement(String name,
 String text)
                       throws IOException

Throws:

IOException

writeBooleanElement

private void writeBooleanElement(String name,
 boolean value)
                          throws IOException

Throws:

IOException