You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2015/04/22 23:13:10 UTC
[20/49] incubator-nifi git commit: NIFI-271 got through nifi-api
NIFI-271 got through nifi-api
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/bcb3ca8f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/bcb3ca8f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/bcb3ca8f
Branch: refs/heads/develop
Commit: bcb3ca8f9886dca675e4b3a895abf83501435eed
Parents: fe8e30a
Author: joewitt <jo...@apache.org>
Authored: Tue Apr 21 12:21:16 2015 -0400
Committer: joewitt <jo...@apache.org>
Committed: Tue Apr 21 12:21:16 2015 -0400
----------------------------------------------------------------------
.../annotation/behavior/DynamicProperties.java | 9 +-
.../annotation/behavior/DynamicProperty.java | 29 +---
.../behavior/DynamicRelationship.java | 15 +-
.../annotation/behavior/ReadsAttribute.java | 19 +--
.../annotation/behavior/ReadsAttributes.java | 13 +-
.../annotation/behavior/SideEffectFree.java | 23 ++--
.../annotation/behavior/TriggerSerially.java | 9 +-
.../TriggerWhenAnyDestinationAvailable.java | 9 +-
.../annotation/behavior/TriggerWhenEmpty.java | 14 +-
.../annotation/behavior/WritesAttribute.java | 20 +--
.../annotation/behavior/WritesAttributes.java | 13 +-
.../documentation/CapabilityDescription.java | 7 +-
.../nifi/annotation/documentation/SeeAlso.java | 21 +--
.../nifi/annotation/documentation/Tags.java | 14 +-
.../nifi/annotation/lifecycle/OnAdded.java | 24 ++--
.../nifi/annotation/lifecycle/OnDisabled.java | 35 ++---
.../nifi/annotation/lifecycle/OnEnabled.java | 43 +++---
.../nifi/annotation/lifecycle/OnRemoved.java | 27 ++--
.../nifi/annotation/lifecycle/OnScheduled.java | 44 +++---
.../nifi/annotation/lifecycle/OnShutdown.java | 23 ++--
.../nifi/annotation/lifecycle/OnStopped.java | 24 ++--
.../annotation/lifecycle/OnUnscheduled.java | 31 +++--
.../apache/nifi/authorization/Authority.java | 12 +-
.../nifi/authorization/AuthorityProvider.java | 99 +++++++-------
.../AuthorityProviderConfigurationContext.java | 12 +-
.../authorization/DownloadAuthorization.java | 33 ++---
.../AbstractConfigurableComponent.java | 14 +-
.../apache/nifi/components/AllowableValue.java | 30 ++--
.../nifi/components/ConfigurableComponent.java | 16 +--
.../nifi/components/PropertyDescriptor.java | 79 +++++------
.../apache/nifi/components/PropertyValue.java | 40 +++---
.../nifi/components/ValidationContext.java | 73 ++++------
.../nifi/components/ValidationResult.java | 16 +--
.../controller/AbstractControllerService.java | 26 ++--
.../nifi/controller/ConfigurationContext.java | 10 +-
.../nifi/controller/ControllerService.java | 48 ++++---
.../ControllerServiceInitializationContext.java | 16 +--
.../controller/ControllerServiceLookup.java | 49 +++----
.../apache/nifi/controller/FlowFileQueue.java | 36 ++---
.../org/apache/nifi/controller/Snippet.java | 48 ++-----
.../org/apache/nifi/controller/Triggerable.java | 15 +-
.../controller/annotation/OnConfigured.java | 5 +-
.../repository/ContentRepository.java | 109 +++++++--------
.../controller/repository/FlowFileRecord.java | 14 +-
.../repository/FlowFileRepository.java | 27 ++--
.../repository/FlowFileSwapManager.java | 6 +-
.../controller/repository/QueueProvider.java | 4 +-
.../controller/repository/RepositoryRecord.java | 36 ++---
.../repository/claim/ContentClaim.java | 6 +-
.../repository/claim/ContentClaimManager.java | 45 +++---
.../controller/status/ProcessGroupStatus.java | 6 +-
.../history/ComponentStatusRepository.java | 58 +++-----
.../status/history/MetricDescriptor.java | 25 ++--
.../status/history/StatusHistory.java | 14 +-
.../status/history/StatusSnapshot.java | 12 +-
.../nifi/expression/AttributeExpression.java | 30 ++--
.../expression/AttributeValueDecorator.java | 4 +-
.../expression/ExpressionLanguageCompiler.java | 10 +-
.../java/org/apache/nifi/flowfile/FlowFile.java | 16 +--
.../org/apache/nifi/logging/ComponentLog.java | 50 +++----
.../org/apache/nifi/logging/ProcessorLog.java | 14 +-
.../AbstractSessionFactoryProcessor.java | 11 +-
.../org/apache/nifi/processor/DataUnit.java | 3 -
.../apache/nifi/processor/FlowFileFilter.java | 6 +-
.../apache/nifi/processor/ProcessContext.java | 31 ++---
.../apache/nifi/processor/ProcessSession.java | 119 ++++++++--------
.../org/apache/nifi/processor/Processor.java | 2 +-
.../ProcessorInitializationContext.java | 12 +-
.../annotation/CapabilityDescription.java | 3 +-
.../nifi/processor/annotation/EventDriven.java | 4 +-
.../nifi/processor/annotation/OnAdded.java | 3 +-
.../nifi/processor/annotation/OnRemoved.java | 3 +-
.../nifi/processor/annotation/OnScheduled.java | 5 +-
.../nifi/processor/annotation/OnShutdown.java | 3 +-
.../nifi/processor/annotation/OnStopped.java | 3 +-
.../processor/annotation/OnUnscheduled.java | 3 +-
.../processor/annotation/SideEffectFree.java | 3 +-
.../processor/annotation/SupportsBatching.java | 3 +-
.../apache/nifi/processor/annotation/Tags.java | 8 +-
.../processor/annotation/TriggerSerially.java | 5 +-
.../TriggerWhenAnyDestinationAvailable.java | 4 +-
.../processor/annotation/TriggerWhenEmpty.java | 3 +-
.../nifi/processor/io/InputStreamCallback.java | 4 +-
.../nifi/processor/io/OutputStreamCallback.java | 4 +-
.../nifi/processor/io/StreamCallback.java | 10 +-
.../nifi/provenance/ProvenanceEventBuilder.java | 120 ++++++++--------
.../nifi/provenance/ProvenanceEventRecord.java | 137 +++++--------------
.../provenance/ProvenanceEventRepository.java | 66 ++++-----
.../lineage/ComputeLineageResult.java | 26 +---
.../lineage/ComputeLineageSubmission.java | 28 ++--
.../apache/nifi/provenance/lineage/Lineage.java | 8 +-
.../nifi/provenance/lineage/LineageNode.java | 22 +--
.../apache/nifi/provenance/search/Query.java | 7 +-
.../nifi/provenance/search/QueryResult.java | 30 ++--
.../nifi/provenance/search/QuerySubmission.java | 18 +--
.../nifi/provenance/search/SearchableField.java | 20 +--
.../apache/nifi/remote/RemoteDestination.java | 47 +++----
.../nifi/reporting/AbstractReportingTask.java | 26 ++--
.../nifi/reporting/BulletinRepository.java | 32 ++---
.../org/apache/nifi/reporting/EventAccess.java | 12 +-
.../apache/nifi/reporting/ReportingContext.java | 36 ++---
.../ReportingInitializationContext.java | 33 ++---
.../apache/nifi/reporting/ReportingTask.java | 6 +-
.../org/apache/nifi/search/SearchContext.java | 18 +--
.../org/apache/nifi/search/SearchResult.java | 16 +--
.../org/apache/nifi/web/ComponentDetails.java | 35 ++---
.../apache/nifi/web/ConfigurationAction.java | 30 ++--
.../nifi/web/NiFiWebConfigurationContext.java | 68 +++++----
.../web/NiFiWebConfigurationRequestContext.java | 5 +-
.../org/apache/nifi/web/NiFiWebContext.java | 18 +--
.../apache/nifi/web/NiFiWebRequestContext.java | 8 +-
.../nifi/web/ProcessorConfigurationAction.java | 24 +---
.../main/java/org/apache/nifi/web/Revision.java | 4 +-
.../org/apache/nifi/web/UiExtensionType.java | 11 +-
.../org/apache/nifi/web/ViewableContent.java | 41 +++---
.../nifi/components/TestPropertyDescriptor.java | 18 +--
116 files changed, 1170 insertions(+), 1684 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperties.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperties.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperties.java
index 6dbc86d..902f5e9 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperties.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperties.java
@@ -25,18 +25,13 @@ import java.lang.annotation.Target;
/**
* Indicates that a component has more than one dynamic property
- *
- * @author
*
*/
@Documented
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface DynamicProperties {
- /**
- * A list of the dynamic properties supported by a component
- * @return A list of the dynamic properties supported by a component
- */
+
public DynamicProperty[] value();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperty.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperty.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperty.java
index 07f349c..dbb34b6 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperty.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicProperty.java
@@ -28,40 +28,19 @@ import org.apache.nifi.components.ConfigurableComponent;
/**
* An annotation that may be placed on a {@link ConfigurableComponent} to
* indicate that it supports a dynamic property.
- *
- * @author
*
*/
@Documented
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface DynamicProperty {
- /**
- * A description of what the name of the dynamic property may be
- *
- * @return A description of what the name of the dynamic property may be
- */
+
public String name();
- /**
- * Indicates whether or not the dynamic property supports expression
- * language
- *
- * @return whether or not the dynamic property supports expression
- * language
- */
public boolean supportsExpressionLanguage() default false;
-
- /**
- * A description of what the value of the dynamic property may be
- * @return a description of what the value of the dynamic property may be
- */
+
public String value();
-
- /**
- * Provides a description of what the meaning of the property is, and what the expected values are
- * @return a description of what the meaning of the property is, and what the expected values are
- */
+
public String description();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicRelationship.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicRelationship.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicRelationship.java
index df0799f..4129201 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicRelationship.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DynamicRelationship.java
@@ -31,26 +31,15 @@ import org.apache.nifi.processor.Relationship;
* Annotation to indicate that a {@link Processor} supports dynamic
* relationship. A dynamic {@link Relationship} is one where the relationship is
* generated based on a user defined {@link PropertyDescriptor}
- *
- * @author
*
*/
@Documented
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface DynamicRelationship {
- /**
- * Describes the name(s) of the dynamic relationship(s)
- *
- * @return a description of the name(s) of the dynamic relationship(s)
- */
+
public String name();
- /**
- * Describes the data that should be routed to the dynamic relationship(s)
- *
- * @return a description the data that should be routed to the dynamic relationship(s)
- */
public String description();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttribute.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttribute.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttribute.java
index d17ec2f..fb9e2ab 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttribute.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttribute.java
@@ -24,27 +24,18 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor}
- * indicating that this processor reads a specific FlowFile attribute.
- *
- * @author
+ * Annotation that may be placed on a
+ * {@link org.apache.nifi.processor.Processor Processor} indicating that this
+ * processor reads a specific FlowFile attribute.
*
*/
-
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ReadsAttribute {
- /**
- * The FlowFile attribute that is being read
- * @return
- */
+
public String attribute();
-
- /**
- * The description of how the attribute is being used
- * @return
- */
+
public String description() default "";
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttributes.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttributes.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttributes.java
index dfa3513..2610e1c 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttributes.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/ReadsAttributes.java
@@ -16,7 +16,6 @@
*/
package org.apache.nifi.annotation.behavior;
-import org.apache.nifi.annotation.behavior.ReadsAttribute;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
@@ -25,10 +24,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor}
- * indicating that this processor reads specific FlowFile attributes.
- *
- * @author
+ * Annotation that may be placed on a
+ * {@link org.apache.nifi.processor.Processor Processor} indicating that this
+ * processor reads specific FlowFile attributes.
*
*/
@Documented
@@ -36,9 +34,6 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ReadsAttributes {
- /**
- * A list of attributes that may be read
- * @return
- */
+
public ReadsAttribute[] value();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
index f32acc3..bd1e07d 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SideEffectFree.java
@@ -24,18 +24,17 @@ import java.lang.annotation.RetentionPolicy;
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 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
- * processor's onTrigger method to the
- * onTrigger method of another processor. It can do this knowing that if
- * something fails along a series of processors using this same session that it
- * can all be safely rolled back without any ill effects on external services
- * which could not be rolled back and thus all the processes could be safely
- * repeated (implied idempotent behavior).
+ * 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
+ * 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
+ * processor's onTrigger method to the onTrigger method of another processor. It
+ * can do this knowing that if something fails along a series of processors
+ * using this same session that it can all be safely rolled back without any ill
+ * effects on external services which could not be rolled back and thus all the
+ * processes could be safely repeated (implied idempotent behavior).
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerSerially.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerSerially.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerSerially.java
index 7bf7d0b..f2f100b 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerSerially.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerSerially.java
@@ -24,11 +24,10 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
- * implementation can use to indicate that the
- * Processor is not safe for concurrent execution of its onTrigger()
- * method. By default, Processors are assumed to be safe for concurrent
- * execution.
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
+ * implementation can use to indicate that the Processor is not safe for
+ * concurrent execution of its onTrigger() method. By default, Processors are
+ * assumed to be safe for concurrent execution.
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenAnyDestinationAvailable.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenAnyDestinationAvailable.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenAnyDestinationAvailable.java
index 803aa2f..8f4da55 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenAnyDestinationAvailable.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenAnyDestinationAvailable.java
@@ -25,11 +25,10 @@ import java.lang.annotation.Target;
/**
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
- * implementation can use to indicate that the
- * Processor is to be triggered if any of its destinations has available space
- * for incoming FlowFiles. By default, Processors are triggered only when all
- * destinations report that they have available space (i.e., none of the outgoing
- * Connections is full).
+ * implementation can use to indicate that the Processor is to be triggered if
+ * any of its destinations has available space for incoming FlowFiles. By
+ * default, Processors are triggered only when all destinations report that they
+ * have available space (i.e., none of the outgoing Connections is full).
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenEmpty.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenEmpty.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenEmpty.java
index fed9b34..0506c08 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenEmpty.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/TriggerWhenEmpty.java
@@ -24,13 +24,13 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
- * implementation can use to indicate that the
- * Processor should still be triggered even when it has no data in its work
- * queue. By default, Processors which have no non-self incoming edges will be
- * triggered even if there is no work in its queue. However, Processors that
- * have non-self incoming edges will only be triggered if they have work in
- * their queue or they present this annotation.
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor}
+ * implementation can use to indicate that the Processor should still be
+ * triggered even when it has no data in its work queue. By default, Processors
+ * which have no non-self incoming edges will be triggered even if there is no
+ * work in its queue. However, Processors that have non-self incoming edges will
+ * only be triggered if they have work in their queue or they present this
+ * annotation.
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttribute.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttribute.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttribute.java
index 31d05d1..841cf40 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttribute.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttribute.java
@@ -24,28 +24,18 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor}
- * indicating that this processor writes/updates a specific FlowFile attribute.
- *
- * @author
+ * Annotation that may be placed on a
+ * {@link org.apache.nifi.processor.Processor Processor} indicating that this
+ * processor writes/updates a specific FlowFile attribute.
*
*/
-
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface WritesAttribute {
-
- /**
- * The FlowFile attribute that is being created or updated
- * @return
- */
+
public String attribute();
-
- /**
- * A description of what is being written to the FlowFile attribute
- * @return
- */
+
public String description() default "";
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttributes.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttributes.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttributes.java
index 4b03af9..3537e72 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttributes.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/WritesAttributes.java
@@ -24,21 +24,16 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor}
- * indicating that this processor writes/updates specific FlowFile attributes.
- *
- * @author
+ * Annotation that may be placed on a
+ * {@link org.apache.nifi.processor.Processor Processor} indicating that this
+ * processor writes/updates specific FlowFile attributes.
*
*/
-
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface WritesAttributes {
- /**
- * A list of FlowFile attributes that may be written or updated
- * @return
- */
+
public WritesAttribute[] value();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/CapabilityDescription.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/CapabilityDescription.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/CapabilityDescription.java
index d69788a..0bdbbc6 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/CapabilityDescription.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/CapabilityDescription.java
@@ -24,10 +24,11 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor},
+ * Annotation that may be placed on a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} allowing for a description to be
- * provided. This description can be provided to a user in logs, UI, etc.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} allowing for a
+ * description to be provided. This description can be provided to a user in
+ * logs, UI, etc.
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java
index d664117..35ca3db 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java
@@ -26,34 +26,19 @@ import java.lang.annotation.Target;
import org.apache.nifi.components.ConfigurableComponent;
/**
- * Annotation that may be placed on a
- * {@link org.apache.nifi.processor.Processor Processor},
+ * Annotation that may be placed on a null {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
* {@link org.apache.nifi.reporting.ReportingTask ReportingTask} that indicates
* this component is related to the components listed.
- *
- * @author
*
*/
-
@Documented
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface SeeAlso {
- /**
- * Classes you want to link to.
- *
- * @return
- */
+
public Class<? extends ConfigurableComponent>[] value() default {};
- /**
- * Fully qualified class names you want to link to. Use this when the class
- * you want to link to is not in the class path of the component you are
- * linking from.
- *
- * @return
- */
public String[] classNames() default {};
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/Tags.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/Tags.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/Tags.java
index 8bd8f9a..366dd4c 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/Tags.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/Tags.java
@@ -24,14 +24,13 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Annotation that can be applied to a {@link org.apache.nifi.processor.Processor Processor},
+ * Annotation that can be applied to a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} in order to associate
- * tags (keywords) with the component. These tags do not affect the component in
- * any way but serve as additional documentation and can be used to sort/filter
- * Processors.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} in order to
+ * associate tags (keywords) with the component. These tags do not affect the
+ * component in any way but serve as additional documentation and can be used to
+ * sort/filter Processors.
*
- * @author none
*/
@Documented
@Target({ElementType.TYPE})
@@ -39,8 +38,5 @@ import java.lang.annotation.Target;
@Inherited
public @interface Tags {
- /**
- * @return all tag values associated with the given processor
- */
public String[] value();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java
index a1286ea..b825335 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnAdded.java
@@ -25,24 +25,24 @@ import java.lang.annotation.Target;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask}
- * implementation can use to indicate a method
- * should be called whenever the component is added to the flow. This method
- * will be called once for the entire life of a component instance.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
+ * can use to indicate a method should be called whenever the component is added
+ * to the flow. This method will be called once for the entire life of a
+ * component instance.
* </p>
- *
+ *
* <p>
- * Methods with this annotation are called without any arguments, as all settings
- * and properties can be assumed to be the defaults.
+ * Methods with this annotation are called without any arguments, as all
+ * settings and properties can be assumed to be the defaults.
* </p>
- *
+ *
* <p>
- * If any method annotated with this annotation throws a Throwable, the component
- * will not be added to the flow.
+ * If any method annotated with this annotation throws a Throwable, the
+ * component will not be added to the flow.
* </p>
- *
+ *
* @author none
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnDisabled.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnDisabled.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnDisabled.java
index b227968..f205bc7 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnDisabled.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnDisabled.java
@@ -27,26 +27,29 @@ import org.apache.nifi.controller.ConfigurationContext;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.controller.ControllerService ControllerService}
- * can use to indicate a method should be called whenever the service is disabled.
- *</p>
+ * Marker annotation a
+ * {@link org.apache.nifi.controller.ControllerService ControllerService} can
+ * use to indicate a method should be called whenever the service is disabled.
+ * </p>
*
* <p>
- * Methods using this annotation are permitted to take zero arguments or to take a single
- * argument of type {@link ConfigurationContext}. If a method with this annotation
- * throws a Throwable, a log message and bulletin will be issued for the service, and the
- * service will remain in a 'DISABLING' state. When this occurs, the method with this annotation
- * will be called again after some period of time. This will continue until the method returns
- * without throwing any Throwable. Until that time, the service will remain in a 'DISABLING' state
- * and cannot be enabled again.
+ * Methods using this annotation are permitted to take zero arguments or to take
+ * a single argument of type {@link ConfigurationContext}. If a method with this
+ * annotation throws a Throwable, a log message and bulletin will be issued for
+ * the service, and the service will remain in a 'DISABLING' state. When this
+ * occurs, the method with this annotation will be called again after some
+ * period of time. This will continue until the method returns without throwing
+ * any Throwable. Until that time, the service will remain in a 'DISABLING'
+ * state and cannot be enabled again.
* </p>
- *
+ *
* <p>
- * Note that this annotation will be ignored if applied to a ReportingTask or Processor. For a Controller
- * Service, enabling and disabling are considered lifecycle events, as the action makes them usable or
- * unusable by other components. However, for a Processor and a Reporting
- * Task, these are not lifecycle events but rather a mechanism to allow a component to be excluded when
- * starting or stopping a group of components.
+ * Note that this annotation will be ignored if applied to a ReportingTask or
+ * Processor. For a Controller Service, enabling and disabling are considered
+ * lifecycle events, as the action makes them usable or unusable by other
+ * components. However, for a Processor and a Reporting Task, these are not
+ * lifecycle events but rather a mechanism to allow a component to be excluded
+ * when starting or stopping a group of components.
* </p>
*
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
index 32aeec6..289b6c4 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
@@ -25,35 +25,40 @@ import java.lang.annotation.Target;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.controller.ControllerService ControllerService}
- * can use to indicate a method should be called whenever the service is enabled.
- * Any method that has this annotation will be called every time a user enables the service.
- * Additionally, each time that NiFi is restarted, if NiFi is configured to "auto-resume state"
- * and the service is enabled, the method will be invoked.
+ * Marker annotation a
+ * {@link org.apache.nifi.controller.ControllerService ControllerService} can
+ * use to indicate a method should be called whenever the service is enabled.
+ * Any method that has this annotation will be called every time a user enables
+ * the service. Additionally, each time that NiFi is restarted, if NiFi is
+ * configured to "auto-resume state" and the service is enabled, the method will
+ * be invoked.
* </p>
*
* <p>
- * Methods using this annotation must take either 0 arguments or a single argument of type
+ * Methods using this annotation must take either 0 arguments or a single
+ * argument of type
* {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
* </p>
- *
+ *
* <p>
- * If a method with this annotation throws a Throwable, a log message and bulletin will be issued
- * for the component. In this event, the service will remain in an 'ENABLING' state and will not be
- * usable. All methods with this annotation will then be called again after a delay. The service will
- * not be made available for use until all methods with this annotation have returned without throwing
- * anything.
+ * If a method with this annotation throws a Throwable, a log message and
+ * bulletin will be issued for the component. In this event, the service will
+ * remain in an 'ENABLING' state and will not be usable. All methods with this
+ * annotation will then be called again after a delay. The service will not be
+ * made available for use until all methods with this annotation have returned
+ * without throwing anything.
* </p>
- *
+ *
* <p>
- * Note that this annotation will be ignored if applied to a ReportingTask or Processor. For a Controller
- * Service, enabling and disabling are considered lifecycle events, as the action makes them usable or
- * unusable by other components. However, for a Processor and a Reporting
- * Task, these are not lifecycle events but rather a mechanism to allow a component to be excluded when
- * starting or stopping a group of components.
+ * Note that this annotation will be ignored if applied to a ReportingTask or
+ * Processor. For a Controller Service, enabling and disabling are considered
+ * lifecycle events, as the action makes them usable or unusable by other
+ * components. However, for a Processor and a Reporting Task, these are not
+ * lifecycle events but rather a mechanism to allow a component to be excluded
+ * when starting or stopping a group of components.
* </p>
*
- *
+ *
*/
@Documented
@Target({ElementType.METHOD})
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnRemoved.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnRemoved.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnRemoved.java
index 71202b4..120b652 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnRemoved.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnRemoved.java
@@ -28,23 +28,24 @@ import org.apache.nifi.processor.ProcessContext;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
- * can use to indicate a method should be called whenever the component is removed
- * from the flow. This method will be called once for the entire life of a
- * component instance. If the method throw any Throwable, that Throwable will be
- * caught and logged but will not prevent subsequent methods with this annotation
- * or removal of the component from the flow.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
+ * can use to indicate a method should be called whenever the component is
+ * removed from the flow. This method will be called once for the entire life of
+ * a component instance. If the method throw any Throwable, that Throwable will
+ * be caught and logged but will not prevent subsequent methods with this
+ * annotation or removal of the component from the flow.
* </p>
- *
+ *
* <p>
- * Methods with this annotation are permitted to take no arguments or to take a single
- * argument. If using a single argument, that argument must be of type {@link ConfigurationContext}
- * if the component is a ReportingTask or a ControllerService. If the component is a Processor,
- * then the argument must be of type {@link ProcessContext}.
+ * Methods with this annotation are permitted to take no arguments or to take a
+ * single argument. If using a single argument, that argument must be of type
+ * {@link ConfigurationContext} if the component is a ReportingTask or a
+ * ControllerService. If the component is a Processor, then the argument must be
+ * of type {@link ProcessContext}.
* </p>
- *
+ *
* @author none
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java
index c012bd7..f5250ea 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java
@@ -25,32 +25,38 @@ import java.lang.annotation.Target;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor} or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
- * can use to indicate a method should be called whenever the component is scheduled
- * to run. This will be called before any call to 'onTrigger' and will be called once each time
- * a Processor or Reporting Task is scheduled to run. This occurs in one of two ways: either
- * a user clicks to schedule the component to run, or NiFi is restarted with the "auto-resume state"
- * configuration set to true (the default value) and the component is already running.
- * </p>
- *
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor} or
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
+ * can use to indicate a method should be called whenever the component is
+ * scheduled to run. This will be called before any call to 'onTrigger' and will
+ * be called once each time a Processor or Reporting Task is scheduled to run.
+ * This occurs in one of two ways: either a user clicks to schedule the
+ * component to run, or NiFi is restarted with the "auto-resume state"
+ * configuration set to true (the default value) and the component is already
+ * running.
+ * </p>
+ *
* <p>
- * Methods using this annotation must take either 0 arguments or a single argument.
+ * Methods using this annotation must take either 0 arguments or a single
+ * argument.
* </p>
- *
+ *
* <p>
- * If using 1 argument and the component using the annotation is a Processor, that argument must
- * be of type {@link org.apache.nifi.processor.ProcessContext ProcessContext}.
+ * If using 1 argument and the component using the annotation is a Processor,
+ * that argument must be of type
+ * {@link org.apache.nifi.processor.ProcessContext ProcessContext}.
* </p>
- *
+ *
* <p>
- * If using 1 argument and the component using the annotation is a Reporting Task, that argument must
- * be of type {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
+ * If using 1 argument and the component using the annotation is a Reporting
+ * Task, that argument must be of type
+ * {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
* </p>
*
- * If any method annotated with this annotation throws any Throwable, the framework will wait a while
- * and then attempt to invoke the method again. This will continue until the method succeeds, and the
- * component will then be scheduled to run after this method return successfully.
+ * If any method annotated with this annotation throws any Throwable, the
+ * framework will wait a while and then attempt to invoke the method again. This
+ * will continue until the method succeeds, and the component will then be
+ * scheduled to run after this method return successfully.
*
* @author none
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnShutdown.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnShutdown.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnShutdown.java
index 3d1ce6c..dd47a31 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnShutdown.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnShutdown.java
@@ -28,21 +28,22 @@ import org.apache.nifi.processor.ProcessContext;
/**
* <p>
- * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
+ * Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService}, or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
- * can use to indicate a method should be called whenever the flow is being shutdown.
- * This will be called at most once for each component in a JVM lifetime.
- * It is not, however, guaranteed that this method will be called on shutdown, as
- * the service may be killed suddenly.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
+ * can use to indicate a method should be called whenever the flow is being
+ * shutdown. This will be called at most once for each component in a JVM
+ * lifetime. It is not, however, guaranteed that this method will be called on
+ * shutdown, as the service may be killed suddenly.
* </p>
- *
+ *
* <p>
- * Methods with this annotation are permitted to take either 0 or 1 argument. If an argument
- * is used, it must be of type {@link ConfigurationContext} if the component is a ReportingTask
- * or Controller Service, or of type {@link ProcessContext} if the component is a Processor.
+ * Methods with this annotation are permitted to take either 0 or 1 argument. If
+ * an argument is used, it must be of type {@link ConfigurationContext} if the
+ * component is a ReportingTask or Controller Service, or of type
+ * {@link ProcessContext} if the component is a Processor.
* </p>
- *
+ *
* @author none
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnStopped.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnStopped.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnStopped.java
index fdc4fd8..c2f2533 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnStopped.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnStopped.java
@@ -29,12 +29,11 @@ import org.apache.nifi.processor.ProcessContext;
/**
* <p>
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor} or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask}
- * implementation can use to indicate that a method
- * should be called whenever the component is no longer scheduled to run.
- * Methods marked with this annotation will be invoked each time the component
- * is stopped and will be invoked only after the last thread has returned from
- * the <code>onTrigger</code> method.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
+ * can use to indicate that a method should be called whenever the component is
+ * no longer scheduled to run. Methods marked with this annotation will be
+ * invoked each time the component is stopped and will be invoked only after the
+ * last thread has returned from the <code>onTrigger</code> method.
* </p>
*
* <p>
@@ -47,14 +46,15 @@ import org.apache.nifi.processor.ProcessContext;
*
* <p>
* To indicate that a method should be called immediately when a component is no
- * longer scheduled to run (as opposed to after all threads have returned from the
- * <code>onTrigger</code> method), see the {@link OnUnscheduled} annotation.
+ * longer scheduled to run (as opposed to after all threads have returned from
+ * the <code>onTrigger</code> method), see the {@link OnUnscheduled} annotation.
* </p>
- *
+ *
* <p>
- * Methods with this annotation are permitted to take either 0 or 1 argument. If an argument
- * is used, it must be of type {@link ConfigurationContext} if the component is a ReportingTask
- * or of type {@link ProcessContext} if the component is a Processor.
+ * Methods with this annotation are permitted to take either 0 or 1 argument. If
+ * an argument is used, it must be of type {@link ConfigurationContext} if the
+ * component is a ReportingTask or of type {@link ProcessContext} if the
+ * component is a Processor.
* </p>
*
* @author none
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnUnscheduled.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnUnscheduled.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnUnscheduled.java
index 5c7e13d..b7d5027 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnUnscheduled.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnUnscheduled.java
@@ -26,26 +26,29 @@ import java.lang.annotation.Target;
/**
* <p>
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor} or
- * {@link org.apache.nifi.reporting.ReportingTask ReportingTask}
- * should be called whenever the component is no longer scheduled to run.
- * Methods marked with this annotation will be invoked each time the framework
- * is notified to stop scheduling the component. This method is invoked as other
- * threads are potentially running. To invoke a method after all threads have
- * finished processing, see the {@link OnStopped} annotation.
+ * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} should be
+ * called whenever the component is no longer scheduled to run. Methods marked
+ * with this annotation will be invoked each time the framework is notified to
+ * stop scheduling the component. This method is invoked as other threads are
+ * potentially running. To invoke a method after all threads have finished
+ * processing, see the {@link OnStopped} annotation.
* </p>
- *
+ *
* <p>
- * Methods using this annotation must take either 0 arguments or a single argument.
+ * Methods using this annotation must take either 0 arguments or a single
+ * argument.
* </p>
- *
+ *
* <p>
- * If using 1 argument and the component using the annotation is a Processor, that argument must
- * be of type {@link org.apache.nifi.processor.ProcessContext ProcessContext}.
+ * If using 1 argument and the component using the annotation is a Processor,
+ * that argument must be of type
+ * {@link org.apache.nifi.processor.ProcessContext ProcessContext}.
* </p>
- *
+ *
* <p>
- * If using 1 argument and the component using the annotation is a Reporting Task, that argument must
- * be of type {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
+ * If using 1 argument and the component using the annotation is a Reporting
+ * Task, that argument must be of type
+ * {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
* </p>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/Authority.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/Authority.java b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/Authority.java
index 823f463..4502c11 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/Authority.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/Authority.java
@@ -34,11 +34,9 @@ public enum Authority {
ROLE_NIFI;
/**
- * Returns the matching role or null if the specified role does not match
- * any roles.
- *
- * @param rawAuthority
- * @return
+ * @param rawAuthority string form of authority
+ * @return the matching role or null if the specified role does not match
+ * any roles
*/
public static Authority valueOfAuthority(String rawAuthority) {
Authority desiredAuthority = null;
@@ -54,9 +52,7 @@ public enum Authority {
}
/**
- * Gets the string value of each authority.
- *
- * @return
+ * @return the string value of each authority
*/
public static Set<String> getRawAuthorities() {
Set<String> authorities = new LinkedHashSet<>();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProvider.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProvider.java b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProvider.java
index 7754c35..723ec33 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProvider.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProvider.java
@@ -31,11 +31,9 @@ import org.apache.nifi.authorization.exception.UnknownIdentityException;
public interface AuthorityProvider {
/**
- * Returns whether the user with the specified DN is known to this authority
- * provider. It is not necessary for the user to have any authorities.
- *
- * @param dn
- * @return
+ * @param dn of the user
+ * @return whether the user with the specified DN is known to this authority
+ * provider. It is not necessary for the user to have any authorities
*/
boolean doesDnExist(String dn) throws AuthorityAccessException;
@@ -43,29 +41,30 @@ public interface AuthorityProvider {
* Get the authorities for the specified user. If the specified user exists
* but does not have any authorities, an empty set should be returned.
*
- * @param dn
- * @return
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ * @param dn of the user to lookup
+ * @return the authorities for the specified user. If the specified user
+ * exists but does not have any authorities, an empty set should be returned
+ * @throws UnknownIdentityException if identity is not known
+ * @throws AuthorityAccessException if unable to access authorities
*/
Set<Authority> getAuthorities(String dn) throws UnknownIdentityException, AuthorityAccessException;
/**
* Sets the specified authorities for the specified user.
*
- * @param dn
- * @param authorities
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ * @param dn the specified user
+ * @param authorities the new authorities for the user
+ * @throws UnknownIdentityException if identity is not known
+ * @throws AuthorityAccessException if unable to access authorities
*/
void setAuthorities(String dn, Set<Authority> authorities) throws UnknownIdentityException, AuthorityAccessException;
/**
* Gets the users for the specified authority.
*
- * @param authority
- * @return
- * @throws AuthorityAccessException
+ * @param authority for which to determine membership of
+ * @return all users with the specified authority
+ * @throws AuthorityAccessException if unable to access authorities
*/
Set<String> getUsers(Authority authority) throws AuthorityAccessException;
@@ -73,19 +72,19 @@ public interface AuthorityProvider {
* Revokes the specified user. Its up to the implementor to determine the
* semantics of revocation.
*
- * @param dn
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ * @param dn the dn of the user
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void revokeUser(String dn) throws UnknownIdentityException, AuthorityAccessException;
/**
* Add the specified user.
*
- * @param dn
+ * @param dn of the user
* @param group Optional
- * @throws IdentityAlreadyExistsException
- * @throws AuthorityAccessException
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void addUser(String dn, String group) throws IdentityAlreadyExistsException, AuthorityAccessException;
@@ -93,10 +92,10 @@ public interface AuthorityProvider {
* Gets the group for the specified user. Return null if the user does not
* belong to a group.
*
- * @param dn
- * @return
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ * @param dn the user
+ * @return the group of the given user
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
String getGroupForUser(String dn) throws UnknownIdentityException, AuthorityAccessException;
@@ -104,26 +103,28 @@ public interface AuthorityProvider {
* Revokes all users for a specified group. Its up to the implementor to
* determine the semantics of revocation.
*
- * @param group
- * @throws AuthorityAccessException
+ * @param group to revoke the users of
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void revokeGroup(String group) throws UnknownIdentityException, AuthorityAccessException;
/**
* Adds the specified users to the specified group.
*
- * @param dn
- * @param group
- * @throws AuthorityAccessException
+ * @param dn the set of users to add to the group
+ * @param group to add users to
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void setUsersGroup(Set<String> dn, String group) throws UnknownIdentityException, AuthorityAccessException;
/**
* Ungroups the specified user.
*
- * @param dn
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ * @param dn of the user
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void ungroupUser(String dn) throws UnknownIdentityException, AuthorityAccessException;
@@ -133,41 +134,41 @@ public interface AuthorityProvider {
* does not exist. If an admin revoked this group before calling ungroup, it
* may or may not exist.
*
- * @param group
- * @throws AuthorityAccessException
+ * @param group to ungroup
+ * @throws AuthorityAccessException if unable to access the authorities
*/
void ungroup(String group) throws AuthorityAccessException;
/**
- * Determines whether the user in the specified dnChain should be able to
+ * Determines whether the user in the specified dnChain should be able to
* download the content for the flowfile with the specified attributes.
- *
- * The first dn in the chain is the end user that the request was issued on
+ *
+ * The first dn in the chain is the end user that the request was issued on
* behalf of. The subsequent dn's in the chain represent entities proxying
* the user's request with the last being the proxy that sent the current
* request.
- *
- * @param dnChain
- * @param attributes
- * @return
- * @throws UnknownIdentityException
- * @throws AuthorityAccessException
+ *
+ * @param dnChain of the user
+ * @param attributes of the flowfile being requested
+ * @return the authorization result
+ * @throws UnknownIdentityException if the user is not known
+ * @throws AuthorityAccessException if unable to access the authorities
*/
DownloadAuthorization authorizeDownload(List<String> dnChain, Map<String, String> attributes) throws UnknownIdentityException, AuthorityAccessException;
-
+
/**
* Called immediately after instance creation for implementers to perform
* additional setup
*
- * @param initializationContext
+ * @param initializationContext in which to initialize
*/
void initialize(AuthorityProviderInitializationContext initializationContext) throws ProviderCreationException;
/**
* Called to configure the AuthorityProvider.
*
- * @param configurationContext
- * @throws ProviderCreationException
+ * @param configurationContext at the time of configuration
+ * @throws ProviderCreationException for any issues configuring the provider
*/
void onConfigured(AuthorityProviderConfigurationContext configurationContext) throws ProviderCreationException;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProviderConfigurationContext.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProviderConfigurationContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProviderConfigurationContext.java
index 6765ed4..c1ba5df 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProviderConfigurationContext.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/AuthorityProviderConfigurationContext.java
@@ -24,9 +24,7 @@ import java.util.Map;
public interface AuthorityProviderConfigurationContext {
/**
- * The identifier for the authority provider.
- *
- * @return
+ * @return identifier for the authority provider
*/
String getIdentifier();
@@ -41,12 +39,10 @@ public interface AuthorityProviderConfigurationContext {
Map<String, String> getProperties();
/**
- * Retrieves the value the component currently understands for the given
+ * @param property to lookup the descriptor and value of
+ * @return the value the component currently understands for the given
* PropertyDescriptor. This method does not substitute default
- * PropertyDescriptor values, so the value returned will be null if not set.
- *
- * @param property
- * @return
+ * PropertyDescriptor values, so the value returned will be null if not set
*/
String getProperty(String property);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/DownloadAuthorization.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/DownloadAuthorization.java b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/DownloadAuthorization.java
index 08695fa..02fd839 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/DownloadAuthorization.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/authorization/DownloadAuthorization.java
@@ -22,6 +22,7 @@ package org.apache.nifi.authorization;
public class DownloadAuthorization {
private static enum Result {
+
Approved,
Denied;
};
@@ -32,10 +33,11 @@ public class DownloadAuthorization {
private final String explanation;
/**
- * Creates a new DownloadAuthorization with the specified result and explanation.
- *
- * @param result
- * @param explanation
+ * Creates a new DownloadAuthorization with the specified result and
+ * explanation.
+ *
+ * @param result of the authorization
+ * @param explanation for the authorization attempt
*/
private DownloadAuthorization(Result result, String explanation) {
if (Result.Denied.equals(result) && explanation == null) {
@@ -47,38 +49,33 @@ public class DownloadAuthorization {
}
/**
- * Whether or not the download request is approved.
- *
- * @return
+ * @return Whether or not the download request is approved
*/
public boolean isApproved() {
return Result.Approved.equals(result);
}
/**
- * If the download request is denied, the reason why. Null otherwise.
- *
- * @return
+ * @return If the download request is denied, the reason why. Null otherwise
*/
public String getExplanation() {
return explanation;
}
/**
- * Creates a new approved DownloadAuthorization.
- *
- * @return
+ * @return a new approved DownloadAuthorization
*/
public static DownloadAuthorization approved() {
return APPROVED;
}
/**
- * Creates a new denied DownloadAuthorization with the specified explanation.
- *
- * @param explanation
- * @return
- * @throws IllegalArgumentException if explanation is null
+ * Creates a new denied DownloadAuthorization with the specified
+ * explanation.
+ *
+ * @param explanation for why it was denied
+ * @return a new denied DownloadAuthorization with the specified explanation
+ * @throws IllegalArgumentException if explanation is null
*/
public static DownloadAuthorization denied(String explanation) {
return new DownloadAuthorization(Result.Denied, explanation);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/AbstractConfigurableComponent.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/AbstractConfigurableComponent.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/AbstractConfigurableComponent.java
index 6736788..1d4e0c2 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/AbstractConfigurableComponent.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/AbstractConfigurableComponent.java
@@ -46,11 +46,9 @@ public abstract class AbstractConfigurableComponent implements ConfigurableCompo
}
/**
- * Returns a PropertyDescriptor for the name specified that is fully
+ * @param descriptorName to lookup the descriptor
+ * @return a PropertyDescriptor for the name specified that is fully
* populated
- *
- * @param descriptorName
- * @return
*/
@Override
public final PropertyDescriptor getPropertyDescriptor(final String descriptorName) {
@@ -141,11 +139,12 @@ public abstract class AbstractConfigurableComponent implements ConfigurableCompo
* method a processor may simply get the latest value whenever it needs it
* and if necessary lazily evaluate it.
*
- * @param descriptor
+ * @param descriptor of the modified property
* @param oldValue non-null property value (previous)
* @param newValue the new property value or if null indicates the property
* was removed
*/
+ @Override
public void onPropertyModified(final PropertyDescriptor descriptor, final String oldValue, final String newValue) {
}
@@ -168,7 +167,7 @@ public abstract class AbstractConfigurableComponent implements ConfigurableCompo
* <p>
* Default is null.
*
- * @param propertyDescriptorName
+ * @param propertyDescriptorName used to lookup if any property descriptors exist for that name
* @return new property descriptor if supported
*/
protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(final String propertyDescriptorName) {
@@ -186,9 +185,10 @@ public abstract class AbstractConfigurableComponent implements ConfigurableCompo
return Collections.EMPTY_LIST;
}
+ @Override
public final List<PropertyDescriptor> getPropertyDescriptors() {
final List<PropertyDescriptor> supported = getSupportedPropertyDescriptors();
- return supported == null ? Collections.<PropertyDescriptor>emptyList() :new ArrayList<>(supported);
+ return supported == null ? Collections.<PropertyDescriptor>emptyList() : new ArrayList<>(supported);
}
@Override
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/AllowableValue.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/AllowableValue.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/AllowableValue.java
index 8921340..a480961 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/AllowableValue.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/AllowableValue.java
@@ -33,7 +33,7 @@ public class AllowableValue {
* Constructs a new AllowableValue with the given value and and the same
* display name and no description.
*
- * @param value
+ * @param value that is allowed
*/
public AllowableValue(final String value) {
this(value, value);
@@ -43,8 +43,8 @@ public class AllowableValue {
* Constructs a new AllowableValue with the given value and display name and
* no description
*
- * @param value
- * @param displayName
+ * @param value that is allowed
+ * @param displayName to display for the value
*
* @throws NullPointerException if either argument is null
*/
@@ -56,9 +56,9 @@ public class AllowableValue {
* Constructs a new AllowableValue with the given value, display name, and
* description
*
- * @param value
- * @param displayName
- * @param description
+ * @param value that is valid
+ * @param displayName to show for the value
+ * @param description of the value
*
* @throws NullPointerException if identifier or value is null
*/
@@ -69,40 +69,33 @@ public class AllowableValue {
}
/**
- * Returns the value of this AllowableValue
- *
- * @return
+ * @return the value of this AllowableValue
*/
public String getValue() {
return value;
}
/**
- * Returns a human-readable name for this AllowableValue
- *
- * @return
+ * @return a human-readable name for this AllowableValue
*/
public String getDisplayName() {
return displayName;
}
/**
- * Returns a description for this value, or <code>null</code> if no
+ * @return a description for this value, or <code>null</code> if no
* description was provided
- *
- * @return
*/
public String getDescription() {
return description;
}
/**
- * <code>this</code> is equal to <code>obj</code> of <code>obj</code> is the
+ * @return true if <code>this</code> is equal to <code>obj</code> of <code>obj</code> is the
* same object as <code>this</code> or if <code>obj</code> is an instance of
* <code>AllowableValue</code> and both have the same value, or if
* <code>obj</code> is a String and is equal to
* {@link #getValue() this.getValue()}.
- * @return
*/
@Override
public boolean equals(final Object obj) {
@@ -121,8 +114,7 @@ public class AllowableValue {
}
/**
- * Hash Code is based solely off of the value
- * @return
+ * @return based solely off of the value
*/
@Override
public int hashCode() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/ConfigurableComponent.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ConfigurableComponent.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ConfigurableComponent.java
index 24e1f3c..8b56f48 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ConfigurableComponent.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ConfigurableComponent.java
@@ -27,7 +27,7 @@ public interface ConfigurableComponent {
* not included in the in the purposed configuration, the default value will
* be used.
*
- * @param context
+ * @param context of validation
* @return Collection of validation result objects for any invalid findings
* only. If the collection is empty then the component is valid. Guaranteed
* non-null
@@ -35,11 +35,9 @@ public interface ConfigurableComponent {
Collection<ValidationResult> validate(ValidationContext context);
/**
- * Returns the PropertyDescriptor with the given name, if it exists;
- * otherwise, returns <code>null</code>.
- *
- * @param name
- * @return
+ * @param name to lookup the descriptor
+ * @return the PropertyDescriptor with the given name, if it exists;
+ * otherwise, returns <code>null</code>
*/
PropertyDescriptor getPropertyDescriptor(String name);
@@ -51,7 +49,7 @@ public interface ConfigurableComponent {
* necessary lazily evaluate it. Any throwable that escapes this method will
* simply be ignored.
*
- * @param descriptor
+ * @param descriptor the descriptor for the property being modified
* @param oldValue the value that was previously set, or null if no value
* was previously set for this property
* @param newValue the new property value or if null indicates the property
@@ -68,10 +66,8 @@ public interface ConfigurableComponent {
List<PropertyDescriptor> getPropertyDescriptors();
/**
- * Returns the unique identifier that the framework assigned to this
+ * @return the unique identifier that the framework assigned to this
* component
- *
- * @return
*/
String getIdentifier();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
index e62ff79..acda6c4 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java
@@ -29,7 +29,6 @@ import org.apache.nifi.controller.ControllerService;
* An immutable object for holding information about a type of processor
* property.
*
- * @author unattributed
*/
public final class PropertyDescriptor implements Comparable<PropertyDescriptor> {
@@ -121,9 +120,9 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
* If this descriptor has a set of allowable values then the given value is
* only checked against the allowable values.
*
- * @param input
- * @param context
- * @return
+ * @param input the value to validate
+ * @param context the context of validation
+ * @return the result of validating the input
*/
public ValidationResult validate(final String input, final ValidationContext context) {
ValidationResult lastResult = Validator.INVALID.validate(this.name, input, context);
@@ -142,17 +141,17 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
final Set<String> validIdentifiers = context.getControllerServiceLookup().getControllerServiceIdentifiers(controllerServiceDefinition);
if (validIdentifiers != null && validIdentifiers.contains(input)) {
final ControllerService controllerService = context.getControllerServiceLookup().getControllerService(input);
- if ( !context.isValidationRequired(controllerService) ) {
+ if (!context.isValidationRequired(controllerService)) {
return new ValidationResult.Builder()
- .input(input)
- .subject(getName())
- .valid(true)
- .build();
+ .input(input)
+ .subject(getName())
+ .valid(true)
+ .build();
}
-
+
final String serviceId = controllerService.getIdentifier();
- if (!context.getControllerServiceLookup().isControllerServiceEnabled(serviceId) &&
- !context.getControllerServiceLookup().isControllerServiceEnabling(serviceId)) {
+ if (!context.getControllerServiceLookup().isControllerServiceEnabled(serviceId)
+ && !context.getControllerServiceLookup().isControllerServiceEnabling(serviceId)) {
return new ValidationResult.Builder()
.input(context.getControllerServiceLookup().getControllerServiceName(serviceId))
.subject(getName())
@@ -235,8 +234,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
* This is beneficial because it allows a User Interface to represent
* the name differently.
*
- * @param displayName
- * @return
+ * @param displayName of the property
+ * @return the builder
*/
public Builder displayName(final String displayName) {
if (null != displayName) {
@@ -249,8 +248,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
/**
* Sets the property name.
*
- * @param name
- * @return
+ * @param name of the property
+ * @return the builder
*/
public Builder name(final String name) {
if (null != name) {
@@ -263,8 +262,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
* Sets the value indicating whether or not this Property will support
* the Attribute Expression Language.
*
- * @param supported
- * @return
+ * @param supported true if yes; false otherwise
+ * @return the builder
*/
public Builder expressionLanguageSupported(final boolean supported) {
this.expressionLanguageSupported = supported;
@@ -272,9 +271,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param description
- * @return
+ * @param description of the property
+ * @return the builder
*/
public Builder description(final String description) {
if (null != description) {
@@ -294,8 +292,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
* should be set to the "Value" of the {@link AllowableValue} object
* (see {@link AllowableValue#getValue()}).
*
- * @param value
- * @return
+ * @param value default value
+ * @return the builder
*/
public Builder defaultValue(final String value) {
if (null != value) {
@@ -310,9 +308,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param values
- * @return
+ * @param values contrained set of values
+ * @return the builder
*/
public Builder allowableValues(final Set<String> values) {
if (null != values) {
@@ -336,9 +333,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param values
- * @return
+ * @param values constrained set of values
+ * @return the builder
*/
public Builder allowableValues(final String... values) {
if (null != values) {
@@ -353,8 +349,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
/**
* Sets the Allowable Values for this Property
*
- * @param values
- * @return
+ * @param values contrained set of values
+ * @return the builder
*/
public Builder allowableValues(final AllowableValue... values) {
if (null != values) {
@@ -364,9 +360,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param required
- * @return
+ * @param required true if yes; false otherwise
+ * @return the builder
*/
public Builder required(final boolean required) {
this.required = required;
@@ -374,9 +369,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param sensitive
- * @return
+ * @param sensitive true if sensitive; false otherwise
+ * @return the builder
*/
public Builder sensitive(final boolean sensitive) {
this.sensitive = sensitive;
@@ -384,9 +378,8 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
}
/**
- *
- * @param validator
- * @return
+ * @param validator for the property
+ * @return the builder
*/
public Builder addValidator(final Validator validator) {
if (validator != null) {
@@ -401,7 +394,7 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
*
* @param controllerServiceDefinition the interface that is implemented
* by the Controller Service
- * @return
+ * @return the builder
*/
public Builder identifiesControllerService(final Class<? extends ControllerService> controllerServiceDefinition) {
if (controllerServiceDefinition != null) {
@@ -436,7 +429,7 @@ public final class PropertyDescriptor implements Comparable<PropertyDescriptor>
throw new IllegalStateException("Must specify a name");
}
if (!isValueAllowed(defaultValue)) {
- throw new IllegalStateException("Default value ["+ defaultValue +"] is not in the set of allowable values");
+ throw new IllegalStateException("Default value [" + defaultValue + "] is not in the set of allowable values");
}
return new PropertyDescriptor(this);
@@ -525,7 +518,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
+ * @param validValues values which are acceptible
* @throws NullPointerException if the given validValues is null
*/
private ConstrainedSetValidator(final Collection<AllowableValue> validValues) {