NIFI-15760 Replaced spelling of "flow file" and "flow files" in the documentation with "FlowFile" and "FlowFiles"

src/main/java/org/apache/nifi/components/PropertyDescriptor.java

@@ -88,7 +88,7 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
     private final boolean dynamic;
     /**
      * indicates whether or nor this property will evaluate expression language
-     * against the flow file attributes
+     * against the FlowFile attributes
      */
     private final ExpressionLanguageScope expressionLanguageScope;
     /**

src/main/java/org/apache/nifi/components/PropertyValue.java

@@ -227,8 +227,8 @@ public interface PropertyValue {
      * be substituted with their values.
      * </p>
      *
-     * @param flowFile to evaluate attributes of. It's flow file properties and
-     * then flow file attributes will take precedence over any underlying
+     * @param flowFile to evaluate attributes of. It's FlowFile properties and
+     * then FlowFile attributes will take precedence over any underlying
      * env/syst properties.
      * @return a PropertyValue with the new value is returned, supporting call
      * chaining
@@ -248,12 +248,12 @@ public interface PropertyValue {
      * be substituted with their values.
      * </p>
      *
-     * @param flowFile to evaluate attributes of. It's flow file properties and
-     * then flow file attributes will take precedence over any underlying
+     * @param flowFile to evaluate attributes of. It's FlowFile properties and
+     * then FlowFile attributes will take precedence over any underlying
      * env/syst properties.
      * @param additionalAttributes a Map of additional attributes that the
      * Expression can reference. These attributes will take precedence over any
-     * conflicting attributes in the provided flowfile or any underlying
+     * conflicting attributes in the provided FlowFile or any underlying
      * env/syst properties.
      *
      * @return a PropertyValue with the new value is returned, supporting call
@@ -274,12 +274,12 @@ public interface PropertyValue {
      * be substituted with their values.
      * </p>
      *
-     * @param flowFile to evaluate attributes of. It's flow file properties and
-     * then flow file attributes will take precedence over any underlying
+     * @param flowFile to evaluate attributes of. It's FlowFile properties and
+     * then FlowFile attributes will take precedence over any underlying
      * env/syst properties.
      * @param additionalAttributes a Map of additional attributes that the
      * Expression can reference. These attributes will take precedence over any
-     * conflicting attributes in the provided flowfile or any underlying
+     * conflicting attributes in the provided FlowFile or any underlying
      * env/syst properties.
      * @param decorator the decorator to use in order to update the values
      * returned after variable substitution and expression language evaluation.

src/main/java/org/apache/nifi/expression/AttributeExpression.java

@@ -47,8 +47,8 @@ public interface AttributeExpression {
 
     /**
      * Evaluates the expression providing access to additional variables
-     * including the flow file properties such as file size, identifier, etc.
-     * and also all the flow file attributes.
+     * including the FlowFile properties such as file size, identifier, etc.
+     * and also all the FlowFile attributes.
      *
      * @param flowFile to evaluate
      * @return evaluated value
@@ -58,8 +58,8 @@ public interface AttributeExpression {
 
     /**
      * Evaluates the expression providing access to additional variables
-     * including the flow file properties such as file size, identifier, etc.
-     * and also all the flow file attributes. The resulting value after
+     * including the FlowFile properties such as file size, identifier, etc.
+     * and also all the FlowFile attributes. The resulting value after
      * executing any variable substitution and expression evaluation is run
      * through the given decorator and returned.
      *

src/main/java/org/apache/nifi/expression/ExpressionLanguageScope.java

@@ -23,14 +23,14 @@
  *      NONE -> ENVIRONMENT -> FLOWFILE_ATTRIBUTES
  *
  * When scope is set to FlowFiles attributes, variables are evaluated
- * against attributes of each incoming flow file. If no matching attribute
+ * against attributes of each incoming FlowFile. If no matching attribute
  * is found, env/syst properties will be checked.
  *
  * NONE - expression language is not supported
  *
  * ENVIRONMENT - Environment variables defined at JVM level and system properties.
  *
- * FLOWFILE_ATTRIBUTES - will check attributes of each individual flow file
+ * FLOWFILE_ATTRIBUTES - will check attributes of each individual FlowFile
  *
  */
 public enum ExpressionLanguageScope {
@@ -46,7 +46,7 @@ public enum ExpressionLanguageScope {
     ENVIRONMENT("Environment variables defined at JVM level and system properties"),
 
     /**
-     * Expression language is evaluated per flow file using attributes
+     * Expression language is evaluated per FlowFile using attributes
      */
     FLOWFILE_ATTRIBUTES("Environment variables and FlowFile Attributes");
 

src/main/java/org/apache/nifi/flow/BatchSize.java

@@ -27,7 +27,7 @@ public class BatchSize {
     private String size;
     private String duration;
 
-    @Schema(description = "Preferred number of flow files to include in a transaction.")
+    @Schema(description = "Preferred number of FlowFiles to include in a transaction.")
     public Integer getCount() {
         return count;
     }

src/main/java/org/apache/nifi/flow/VersionedConnection.java

@@ -116,7 +116,7 @@ public void setBackPressureDataSizeThreshold(String backPressureDataSizeThreshol
     }
 
 
-    @Schema(description = "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from "
+    @Schema(description = "The amount of time a FlowFile may be in the flow before it will be automatically aged out of the flow. Once a FlowFile reaches this age it will be terminated from "
         + "the flow the next time a processor attempts to start work on it.")
     public String getFlowFileExpiration() {
         return flowFileExpiration;

src/main/java/org/apache/nifi/flow/VersionedProcessor.java

@@ -70,7 +70,7 @@ public void setExecutionNode(String executionNode) {
         this.executionNode = executionNode;
     }
 
-    @Schema(description = "The amount of time that is used when the process penalizes a flowfile.")
+    @Schema(description = "The amount of time that is used when the process penalizes a FlowFile.")
     public String getPenaltyDuration() {
         return penaltyDuration;
     }
@@ -116,7 +116,7 @@ public void setAnnotationData(String annotationData) {
     }
 
 
-    @Schema(description = "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs "
+    @Schema(description = "The names of all relationships that cause a FlowFile to be terminated if the relationship is not connected elsewhere. This property differs "
         + "from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this "
         + "property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.")
     public Set<String> getAutoTerminatedRelationships() {

src/main/java/org/apache/nifi/flow/VersionedRemoteGroupPort.java

@@ -30,7 +30,7 @@ public class VersionedRemoteGroupPort extends VersionedComponent {
     private String targetId;
     private ScheduledState scheduledState;
 
-    @Schema(description = "The number of task that may transmit flowfiles to the target port concurrently.")
+    @Schema(description = "The number of task that may transmit FlowFiles to the target port concurrently.")
     public Integer getConcurrentlySchedulableTaskCount() {
         return concurrentlySchedulableTaskCount;
     }
@@ -49,7 +49,7 @@ public void setRemoteGroupId(String groupId) {
     }
 
 
-    @Schema(description = "Whether the flowfiles are compressed when sent to the target port.")
+    @Schema(description = "Whether the FlowFiles are compressed when sent to the target port.")
     public Boolean isUseCompression() {
         return useCompression;
     }

src/main/java/org/apache/nifi/flowfile/FlowFile.java

@@ -20,7 +20,7 @@
 
 /**
  * <p>
- * A flow file is a logical notion of an item in a flow with its associated
+ * A FlowFile is a logical notion of an item in a flow with its associated
  * attributes and identity which can be used as a reference for its actual
  * content.</p>
  *
@@ -29,17 +29,17 @@
 public interface FlowFile extends Comparable<FlowFile> {
 
     /**
-     * @return the unique identifier for this flow file which is guaranteed
+     * @return the unique identifier for this FlowFile which is guaranteed
      * to be unique within a single running instance of nifi.  This identifier
      * should not be used for true universal unique type needs.  For that consider
-     * using the attribute found in the flow file's attribute map keyed by
+     * using the attribute found in the FlowFile's attribute map keyed by
      * CoreAttributes.UUID.
      * For example, by calling getAttribute(CoreAttributes.UUID.key()).
      */
     long getId();
 
     /**
-     * @return the date at which the flow file entered the flow
+     * @return the date at which the FlowFile entered the flow
      */
     long getEntryDate();
 
@@ -86,7 +86,7 @@ public interface FlowFile extends Comparable<FlowFile> {
     long getQueueDateIndex();
 
     /**
-     * @return true if flow file is currently penalized; false otherwise;
+     * @return true if FlowFile is currently penalized; false otherwise;
      */
     boolean isPenalized();
 
@@ -99,12 +99,12 @@ public interface FlowFile extends Comparable<FlowFile> {
     String getAttribute(String key);
 
     /**
-     * @return size of flow file contents in bytes
+     * @return size of FlowFile contents in bytes
      */
     long getSize();
 
     /**
-     * @return an unmodifiable map of the flow file attributes
+     * @return an unmodifiable map of the FlowFile attributes
      */
     Map<String, String> getAttributes();
 

src/main/java/org/apache/nifi/processor/Processor.java

@@ -62,7 +62,7 @@ public interface Processor extends ConfigurableComponent {
 
     /**
      * @return Set of all relationships this processor expects to transfer a
-     * flow file to. An empty set indicates this processor does not have any
+     * FlowFile to. An empty set indicates this processor does not have any
      * destination relationships. Guaranteed non null.
      */
     Set<Relationship> getRelationships();

src/main/java/org/apache/nifi/processor/exception/FlowFileHandlingException.java

@@ -17,7 +17,7 @@
 package org.apache.nifi.processor.exception;
 
 /**
- * Thrown when a flow file is referenced that is not part of the appropriate
+ * Thrown when a FlowFile is referenced that is not part of the appropriate
  * session or is not properly accounted for by a transfer or removal within a
  * session. In any event this exception indicates a logic or programming error
  * within the processor interacting with the offending session.

src/main/java/org/apache/nifi/provenance/ProvenanceEventBuilder.java

@@ -45,7 +45,7 @@ public interface ProvenanceEventBuilder {
     /**
      * Sets the date and time at which the FlowFile entered the flow
      *
-     * @param entryDate of the flow file
+     * @param entryDate of the FlowFile
      * @return the builder
      */
     ProvenanceEventBuilder setFlowFileEntryDate(long entryDate);
@@ -102,7 +102,7 @@ public interface ProvenanceEventBuilder {
     /**
      * Sets the UUID to associate with the FlowFile
      *
-     * @param uuid of the flowfile
+     * @param uuid of the FlowFile
      * @return the builder
      */
     ProvenanceEventBuilder setFlowFileUUID(String uuid);
@@ -190,7 +190,7 @@ public interface ProvenanceEventBuilder {
      * {@link ProvenanceEventType#CLONE} events and will be ignored for any
      * other event types.
      *
-     * @param parent flowfile that this event is derived from
+     * @param parent FlowFile that this event is derived from
      * @return the builder
      */
     ProvenanceEventBuilder addParentFlowFile(FlowFile parent);
@@ -259,7 +259,7 @@ public interface ProvenanceEventBuilder {
      * This is valid only for {@link ProvenanceEventType#ADDINFO} events and
      * will be ignored for any other event types.
      *
-     * @param alternateIdentifierUri another identifier of the flowfile this event is for
+     * @param alternateIdentifierUri another identifier of the FlowFile this event is for
      * @return the builder
      */
     ProvenanceEventBuilder setAlternateIdentifierUri(String alternateIdentifierUri);
@@ -279,7 +279,7 @@ public interface ProvenanceEventBuilder {
      * {@link ProvenanceEventType#ROUTE} events and will be ignored for any
      * other event types.
      *
-     * @param relationship to which flowfiles in this event were routed
+     * @param relationship to which FlowFiles in this event were routed
      * @return the builder
      */
     ProvenanceEventBuilder setRelationship(Relationship relationship);

src/main/java/org/apache/nifi/reporting/EventAccess.java

@@ -108,7 +108,7 @@ public interface EventAccess {
     Map<String, StorageUsage> getContentRepositoryStorageUsage();
 
     /**
-     * Returns the storage usage of the flow file repository
+     * Returns the storage usage of the FlowFile repository
      * @return the storage usage
      */
     StorageUsage getFlowFileRepositoryStorageUsage();