This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi-api.git
The following commit(s) were added to refs/heads/main by this push:
new 66891e9 NIFI-15502 Fixed typos and some of the grammar in the
comments (#59)
66891e9 is described below
commit 66891e97534f169933e2e4717ff0e1d79cc135b6
Author: dan-s1 <[email protected]>
AuthorDate: Tue Feb 3 12:10:31 2026 -0500
NIFI-15502 Fixed typos and some of the grammar in the comments (#59)
Signed-off-by: David Handermann <[email protected]>
---
.../nifi/annotation/behavior/RequiresInstanceClassLoading.java | 2 +-
.../java/org/apache/nifi/annotation/behavior/SideEffectFree.java | 2 +-
.../org/apache/nifi/annotation/behavior/SupportsBatching.java | 2 +-
src/main/java/org/apache/nifi/components/AllowableValue.java | 2 +-
src/main/java/org/apache/nifi/components/DescribedValue.java | 2 +-
src/main/java/org/apache/nifi/components/PropertyDescriptor.java | 4 ++--
.../java/org/apache/nifi/components/resource/ResourceContext.java | 2 +-
.../org/apache/nifi/components/resource/ResourceReference.java | 2 +-
.../org/apache/nifi/components/resource/ResourceReferences.java | 2 +-
.../java/org/apache/nifi/controller/ConfigurationContext.java | 2 +-
.../nifi/controller/status/analytics/StatusAnalyticsEngine.java | 2 +-
src/main/java/org/apache/nifi/expression/AttributeExpression.java | 8 ++++----
src/main/java/org/apache/nifi/flow/VersionedProcessor.java | 6 +++---
src/main/java/org/apache/nifi/flowfile/FlowFile.java | 2 +-
src/main/java/org/apache/nifi/kerberos/KerberosContext.java | 2 +-
src/main/java/org/apache/nifi/logging/ComponentLog.java | 2 +-
src/main/java/org/apache/nifi/processor/Processor.java | 2 +-
.../java/org/apache/nifi/provenance/ProvenanceEventBuilder.java | 2 +-
.../java/org/apache/nifi/provenance/ProvenanceEventRecord.java | 4 ++--
src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java | 2 +-
src/main/java/org/apache/nifi/reporting/EventAccess.java | 2 +-
src/main/java/org/apache/nifi/reporting/ReportingContext.java | 2 +-
.../org/apache/nifi/reporting/ReportingInitializationContext.java | 2 +-
23 files changed, 30 insertions(+), 30 deletions(-)
diff --git
a/src/main/java/org/apache/nifi/annotation/behavior/RequiresInstanceClassLoading.java
b/src/main/java/org/apache/nifi/annotation/behavior/RequiresInstanceClassLoading.java
index 0796199..8d62fb0 100644
---
a/src/main/java/org/apache/nifi/annotation/behavior/RequiresInstanceClassLoading.java
+++
b/src/main/java/org/apache/nifi/annotation/behavior/RequiresInstanceClassLoading.java
@@ -37,7 +37,7 @@ import java.lang.annotation.Target;
* Example #2 - If PutHDFS referenced an SSLContext and has this flag set to
true, then it would include
* resources from nifi-hadoop-nar, nifi-hadoop-libraries-nar, and stop before
nifi-standard-services-api-nar.
*
- * Example #3 - HBaseClientService_1_1_2 does not have this flag set so it
defaults to false, and therefore includes
+ * Example #3 - HBaseClientService_1_1_2 does not have this flag set, so it
defaults to false, and therefore includes
* only resources from the nifi-hbase-client-service-1_1_2-nar.
*
* NOTE: When this annotation is used it is important to note that each added
instance of the component will increase
diff --git
a/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
b/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
index 9a64f4b..c0b8ef7 100644
--- a/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
+++ b/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
/**
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
* implementation can use to indicate that its operations on FlowFiles can be
- * safely repeated across process sessions. If a processor has this annotation
+ * safely repeated across process sessions. If a processor has this annotation,
* and it allows the framework to manage session commit and rollback then the
* framework may elect to cascade a
* {@link org.apache.nifi.processor.ProcessSession ProcessSession} given to
this
diff --git
a/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java
b/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java
index 49136ad..3cd8022 100644
--- a/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java
+++ b/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java
@@ -41,7 +41,7 @@ import java.lang.annotation.Target;
* ProcessSession.commit() to ensure data is persisted before deleting the data
* from a remote source.
*
- * When the defaultDuration parameter is set, the processor is created with
the supplied duration time, which can be adjusted afterwards.
+ * When the defaultDuration parameter is set, the processor is created with
the supplied duration time, which can be adjusted afterward.
* The supplied values can be selected from {@link
org.apache.nifi.annotation.behavior.DefaultRunDuration}.
*/
@Documented
diff --git a/src/main/java/org/apache/nifi/components/AllowableValue.java
b/src/main/java/org/apache/nifi/components/AllowableValue.java
index 9cae438..b1cffd4 100644
--- a/src/main/java/org/apache/nifi/components/AllowableValue.java
+++ b/src/main/java/org/apache/nifi/components/AllowableValue.java
@@ -30,7 +30,7 @@ public class AllowableValue implements DescribedValue {
private final String description;
/**
- * Constructs a new AllowableValue with the given value and and the same
+ * Constructs a new AllowableValue with the given value and the same
* display name and no description.
*
* @param value that is allowed
diff --git a/src/main/java/org/apache/nifi/components/DescribedValue.java
b/src/main/java/org/apache/nifi/components/DescribedValue.java
index 87ffc2f..a8f1304 100644
--- a/src/main/java/org/apache/nifi/components/DescribedValue.java
+++ b/src/main/java/org/apache/nifi/components/DescribedValue.java
@@ -32,7 +32,7 @@ public interface DescribedValue {
String getDisplayName();
/**
- * @return the proeprty description as a string
+ * @return the property description as a string
*/
String getDescription();
}
diff --git a/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
b/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
index 91dd576..5e959d2 100644
--- a/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
+++ b/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
@@ -565,7 +565,7 @@ public final class PropertyDescriptor implements
Comparable<PropertyDescriptor>
* is used, the input must be a regular file. If
<code>identifiesExternalResource(ResourceCardinality.SINGLE, ResourceType.FILE,
ResourceType.DIRECTORY)</code> is used, then the input
* must be exactly one file OR directory.
* </li>
- * <li>If the ResourceCardinality is MULTIPLE, the given property
value may consist of one or more resources, each separted by a comma and
optional white space.</li>
+ * <li>If the ResourceCardinality is MULTIPLE, the given property
value may consist of one or more resources, each separated by a comma and
optional white space.</li>
* </ul>
* <p>
* Generally, any property descriptor that makes use of the {@link
#dynamicallyModifiesClasspath(boolean)} method to dynamically update its
classpath should also
@@ -827,7 +827,7 @@ public final class PropertyDescriptor implements
Comparable<PropertyDescriptor>
* Constructs a validator that will check if the given value is in the
* given set.
*
- * @param validValues values which are acceptible
+ * @param validValues values which are acceptable
* @throws NullPointerException if the given validValues is null
*/
private ConstrainedSetValidator(final Collection<AllowableValue>
validValues) {
diff --git
a/src/main/java/org/apache/nifi/components/resource/ResourceContext.java
b/src/main/java/org/apache/nifi/components/resource/ResourceContext.java
index bf02c59..f573200 100644
--- a/src/main/java/org/apache/nifi/components/resource/ResourceContext.java
+++ b/src/main/java/org/apache/nifi/components/resource/ResourceContext.java
@@ -20,7 +20,7 @@ package org.apache.nifi.components.resource;
import org.apache.nifi.components.PropertyDescriptor;
/**
- * Provides the context in which a Reference Reference is to be evaluated
+ * Provides the context in which a Reference is to be evaluated
*/
public interface ResourceContext {
/**
diff --git
a/src/main/java/org/apache/nifi/components/resource/ResourceReference.java
b/src/main/java/org/apache/nifi/components/resource/ResourceReference.java
index 49b95d3..dcf7126 100644
--- a/src/main/java/org/apache/nifi/components/resource/ResourceReference.java
+++ b/src/main/java/org/apache/nifi/components/resource/ResourceReference.java
@@ -47,7 +47,7 @@ public interface ResourceReference {
/**
* Indicates whether or not the resource is accessible. What it means for
the resource to be accessible depends on the type of
* resource. A File resource, for example, might be accessible only if the
file exists and is readable, while a URL resource might
- * always be considered accessible, or might be accesssible only if the
existence of the resource can be confirmed.
+ * always be considered accessible, or might be accessible only if the
existence of the resource can be confirmed.
*
* @return <code>true</code> if the file can be accessed,
<code>false</code> otherwise
*/
diff --git
a/src/main/java/org/apache/nifi/components/resource/ResourceReferences.java
b/src/main/java/org/apache/nifi/components/resource/ResourceReferences.java
index 5addba0..bcc4f01 100644
--- a/src/main/java/org/apache/nifi/components/resource/ResourceReferences.java
+++ b/src/main/java/org/apache/nifi/components/resource/ResourceReferences.java
@@ -51,7 +51,7 @@ public interface ResourceReferences {
* holds a single ResourceReference, of type DIRECTORY and the referenced
directory contains 10 files. Calling {@link #asList()} would
* return a single ResourceReference. But calling <code>flatten()</code>
would return a new ResourceReferences type whose {@link #asList()}
* method would return 10 ResourceReference objects, each with a
ResourceType of FILE. The flatten operation is not recursive, meaning that if
- * a DIRECTORY is flattened, any sub-directories will be dropped. If the
contents of the subdirectories are to be retained, use {@link
#flattenRecursively()}
+ * a DIRECTORY is flattened, any subdirectories will be dropped. If the
contents of the subdirectories are to be retained, use {@link
#flattenRecursively()}
* instead.
*
* @return a flattened ResourceReferences
diff --git a/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
b/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
index 2886a2a..96e2f6f 100644
--- a/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
+++ b/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
@@ -47,7 +47,7 @@ public interface ConfigurationContext extends PropertyContext
{
/**
* Returns the amount of time, in the given {@link TimeUnit} that will
- * elapsed between the return of one execution of the
+ * elapse between the return of one execution of the
* component's <code>onTrigger</code> method and
* the time at which the method is invoked again. This method will return
* null if the component does not have a scheduling period (e.g., for
ControllerServices)
diff --git
a/src/main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsEngine.java
b/src/main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsEngine.java
index 57c13e6..429b654 100644
---
a/src/main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsEngine.java
+++
b/src/main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsEngine.java
@@ -21,7 +21,7 @@ public interface StatusAnalyticsEngine {
/**
* Retrieve status analytics object for given component
* @param componentId identifier for component
- * @return componenet specific status analytics object
+ * @return component specific status analytics object
*/
StatusAnalytics getStatusAnalytics(String componentId);
diff --git a/src/main/java/org/apache/nifi/expression/AttributeExpression.java
b/src/main/java/org/apache/nifi/expression/AttributeExpression.java
index e3b8751..94ac7e5 100644
--- a/src/main/java/org/apache/nifi/expression/AttributeExpression.java
+++ b/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 of the flow file attributes.
+ * including the flow file properties such as file size, identifier, etc.
+ * and also all the flow file 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 of the flow file attributes. The resulting value after
+ * including the flow file properties such as file size, identifier, etc.
+ * and also all the flow file attributes. The resulting value after
* executing any variable substitution and expression evaluation is run
* through the given decorator and returned.
*
diff --git a/src/main/java/org/apache/nifi/flow/VersionedProcessor.java
b/src/main/java/org/apache/nifi/flow/VersionedProcessor.java
index a3ca3c3..5acc2c1 100644
--- a/src/main/java/org/apache/nifi/flow/VersionedProcessor.java
+++ b/src/main/java/org/apache/nifi/flow/VersionedProcessor.java
@@ -70,7 +70,7 @@ public class VersionedProcessor extends
VersionedConfigurableExtension {
this.executionNode = executionNode;
}
- @Schema(description = "The amout 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;
}
@@ -97,7 +97,7 @@ public class VersionedProcessor extends
VersionedConfigurableExtension {
this.bulletinLevel = bulletinLevel;
}
- @Schema(description = "The number of tasks that should be concurrently
schedule for the processor. If the processor doesn't allow parallol processing
then any positive input will be ignored.")
+ @Schema(description = "The number of tasks that should be concurrently
schedule for the processor. If the processor doesn't allow parallel processing
then any positive input will be ignored.")
public Integer getConcurrentlySchedulableTaskCount() {
return concurrentlySchedulableTaskCount;
}
@@ -106,7 +106,7 @@ public class VersionedProcessor extends
VersionedConfigurableExtension {
this.concurrentlySchedulableTaskCount =
concurrentlySchedulableTaskCount;
}
- @Schema(description = "The annotation data for the processor used to relay
configuration between a custom UI and the procesosr.")
+ @Schema(description = "The annotation data for the processor used to relay
configuration between a custom UI and the processor.")
public String getAnnotationData() {
return annotationData;
}
diff --git a/src/main/java/org/apache/nifi/flowfile/FlowFile.java
b/src/main/java/org/apache/nifi/flowfile/FlowFile.java
index cf2805d..e08de96 100644
--- a/src/main/java/org/apache/nifi/flowfile/FlowFile.java
+++ b/src/main/java/org/apache/nifi/flowfile/FlowFile.java
@@ -116,7 +116,7 @@ public interface FlowFile extends Comparable<FlowFile> {
public static String validateKey(final String key) {
// We used to validate the key by disallowing a handful of
keywords, but this requirement no longer exists.
- // Therefore this method simply verifies that the key is not empty.
+ // Therefore, this method simply verifies that the key is not
empty.
if (key == null) {
throw new IllegalArgumentException("Invalid attribute key:
null");
}
diff --git a/src/main/java/org/apache/nifi/kerberos/KerberosContext.java
b/src/main/java/org/apache/nifi/kerberos/KerberosContext.java
index a30e7cd..9da52d3 100644
--- a/src/main/java/org/apache/nifi/kerberos/KerberosContext.java
+++ b/src/main/java/org/apache/nifi/kerberos/KerberosContext.java
@@ -22,7 +22,7 @@ public interface KerberosContext {
/**
* The Kerberos service principal used by NiFi to communicate with the KDC
- * in order to obtain tickets on behalf of NiFi. Typically of the form
+ * in order to obtain tickets on behalf of NiFi. Typically, of the form
* NIFI/fully.qualified.domain@REALM.
*
* @return the principal, or null if this NiFi instance is not configured
diff --git a/src/main/java/org/apache/nifi/logging/ComponentLog.java
b/src/main/java/org/apache/nifi/logging/ComponentLog.java
index db03fd7..b56bc4f 100644
--- a/src/main/java/org/apache/nifi/logging/ComponentLog.java
+++ b/src/main/java/org/apache/nifi/logging/ComponentLog.java
@@ -35,7 +35,7 @@ package org.apache.nifi.logging;
* Throwable, then the logged message will include a <code>toString()</code> of
* the Throwable; in addition, if the component's logger is set to DEBUG level
* via the logback configuration, the Stacktrace will also be logged. This
- * provides a mechanism to easily enable stacktraces in the logs when they are
+ * provides a mechanism to easily enable stack traces in the logs when they are
* desired without filling the logs with unneeded stack traces for messages
that
* end up occurring often.
* </li>
diff --git a/src/main/java/org/apache/nifi/processor/Processor.java
b/src/main/java/org/apache/nifi/processor/Processor.java
index 78851ec..e425b33 100644
--- a/src/main/java/org/apache/nifi/processor/Processor.java
+++ b/src/main/java/org/apache/nifi/processor/Processor.java
@@ -85,7 +85,7 @@ public interface Processor extends ConfigurableComponent {
* @throws ProcessException if processing did not complete normally though
* indicates the problem is an understood potential outcome of processing.
* The controller/caller will handle these exceptions gracefully such as
- * logging, etc.. If another type of exception is allowed to propagate the
+ * logging, etc. If another type of exception is allowed to propagate the
* controller may no longer trigger this processor to operate, as this
would
* indicate a probable coding defect.
*/
diff --git
a/src/main/java/org/apache/nifi/provenance/ProvenanceEventBuilder.java
b/src/main/java/org/apache/nifi/provenance/ProvenanceEventBuilder.java
index 918c638..ccbda42 100644
--- a/src/main/java/org/apache/nifi/provenance/ProvenanceEventBuilder.java
+++ b/src/main/java/org/apache/nifi/provenance/ProvenanceEventBuilder.java
@@ -298,7 +298,7 @@ public interface ProvenanceEventBuilder {
* {@link ProvenanceEventRecord#getEventId()} on the
* {@link ProvenanceEventRecord} that is returned will yield
* <code>-1</code>. This is because the implementation of the Event may
- * depend on the Provevenance Event Repository to generate the unique
+ * depend on the Provenance Event Repository to generate the unique
* identifier.
*
* @return the event
diff --git
a/src/main/java/org/apache/nifi/provenance/ProvenanceEventRecord.java
b/src/main/java/org/apache/nifi/provenance/ProvenanceEventRecord.java
index b781afe..fc74a3a 100644
--- a/src/main/java/org/apache/nifi/provenance/ProvenanceEventRecord.java
+++ b/src/main/java/org/apache/nifi/provenance/ProvenanceEventRecord.java
@@ -133,7 +133,7 @@ public interface ProvenanceEventRecord {
/**
* Since the receiving system will usually refer to the data using a
* different identifier than the source system, this information is used to
- * correlate the receive system's FlowFile with the sending system's data
+ * correlate the receiving system's FlowFile with the sending system's data
*
* @return the UUID that the Source System used to refer to this data; this
* is applicable only when the {@link ProvenanceEventType} is of type
@@ -184,7 +184,7 @@ public interface ProvenanceEventRecord {
/**
* @return the identifier of the queue from which the FlowFile was taken,
if
* any. If the FlowFile is created as a result of this event (in this case,
- * the Event Type is one of null null null null null null null null
{@link ProvenanceEventType#CREATE}, {@link ProvenanceEventType#RECEIVE},
+ * the Event Type is one of {@link ProvenanceEventType#CREATE}, {@link
ProvenanceEventType#RECEIVE},
* {@link ProvenanceEventType#FORK}, {@link ProvenanceEventType#JOIN}, or
* {@link ProvenanceEventType#CLONE}), or if the queue identifier is
* unknown, then this method will return <code>null</code>
diff --git a/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
b/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
index b5a8aff..aaa23dc 100644
--- a/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
+++ b/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
@@ -126,7 +126,7 @@ public enum ProvenanceEventType {
* event will indicate the UUID of the original FlowFile that is being
* replayed. The event will contain exactly one Parent UUID that is also
the
* UUID of the FlowFile that is being replayed and exactly one Child UUID
- * that is the UUID of the a newly created FlowFile that will be re-queued
+ * that is the UUID of the newly created FlowFile that will be re-queued
* for processing.
*/
REPLAY,
diff --git a/src/main/java/org/apache/nifi/reporting/EventAccess.java
b/src/main/java/org/apache/nifi/reporting/EventAccess.java
index 3873b06..d7d06dc 100644
--- a/src/main/java/org/apache/nifi/reporting/EventAccess.java
+++ b/src/main/java/org/apache/nifi/reporting/EventAccess.java
@@ -42,7 +42,7 @@ public interface EventAccess {
/**
* Convenience method to obtain Provenance Events starting with (and
* including) the given ID. If no event exists with that ID, the first
event
- * to be returned will be have an ID greater than
<code>firstEventId</code>.
+ * to be returned will have an ID greater than <code>firstEventId</code>.
*
* @param firstEventId the ID of the first event to obtain
* @param maxRecords the maximum number of records to obtain
diff --git a/src/main/java/org/apache/nifi/reporting/ReportingContext.java
b/src/main/java/org/apache/nifi/reporting/ReportingContext.java
index 253089d..c72bd46 100644
--- a/src/main/java/org/apache/nifi/reporting/ReportingContext.java
+++ b/src/main/java/org/apache/nifi/reporting/ReportingContext.java
@@ -54,7 +54,7 @@ public interface ReportingContext extends PropertyContext {
/**
* Creates a controller-level {@link Bulletin} with the given category,
severity
* level, and message, so that the Bulletin can be added to the
- * {@link BulletinRepository}. Access to this bulletin will be enforce
through
+ * {@link BulletinRepository}. Access to this bulletin will be enforced
through
* permissions on the controller.
*
* @param category of bulletin
diff --git
a/src/main/java/org/apache/nifi/reporting/ReportingInitializationContext.java
b/src/main/java/org/apache/nifi/reporting/ReportingInitializationContext.java
index 8851eae..7ddd119 100644
---
a/src/main/java/org/apache/nifi/reporting/ReportingInitializationContext.java
+++
b/src/main/java/org/apache/nifi/reporting/ReportingInitializationContext.java
@@ -42,7 +42,7 @@ public interface ReportingInitializationContext extends
KerberosContext {
/**
* Returns the amount of time, in the given {@link TimeUnit} that will
- * elapsed between the return of one execution of the
+ * elapse between the return of one execution of the
* {@link ReportingTask}'s
* {@link ReportingTask#onTrigger(ReportingContext) onTrigger} method and
* the time at which the method is invoked again. This method will return
