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:09 UTC
[19/49] incubator-nifi git commit: NIFI-271 got through nifi-api
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java
index 1c5f04a..1845ed2 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/PropertyValue.java
@@ -89,25 +89,21 @@ public interface PropertyValue {
public Double asDataSize(DataUnit dataUnit);
/**
- * Returns the ControllerService whose identifier is the raw value of
+ * @return the ControllerService whose identifier is the raw value of
* <code>this</code>, or <code>null</code> if either the value is not set or
* the value does not identify a ControllerService
- *
- * @return
*/
public ControllerService asControllerService();
/**
- * Returns the ControllerService whose identifier is the raw value of the
+ * @param <T> the generic type of the controller service
+ * @param serviceType the class of the Controller Service
+ * @return the ControllerService whose identifier is the raw value of the
* <code>this</code>, or <code>null</code> if either the value is not set or
* the value does not identify a ControllerService. The object returned by
* this method is explicitly cast to type specified, if the type specified
* is valid. Otherwise, throws an IllegalArgumentException
*
- * @param <T>
- * @param serviceType
- * @return
- *
* @throws IllegalArgumentException if the value of <code>this</code> points
* to a ControllerService but that service is not of type
* <code>serviceType</code> or if <code>serviceType</code> references a
@@ -116,11 +112,9 @@ public interface PropertyValue {
public <T extends ControllerService> T asControllerService(Class<T> serviceType) throws IllegalArgumentException;
/**
- * Returns <code>true</code> if the user has configured a value, or if the
+ * @return <code>true</code> if the user has configured a value, or if the
* {@link PropertyDescriptor} for the associated property has a default
- * value, <code>false</code> otherwise.
- *
- * @return
+ * value, <code>false</code> otherwise
*/
public boolean isSet();
@@ -131,7 +125,8 @@ public interface PropertyValue {
* call chaining.
* </p>
*
- * @return
+ * @return a PropertyValue with the new value is returned, supporting call
+ * chaining
*
* @throws ProcessException if the Query cannot be compiled or evaluating
* the query against the given attributes causes an Exception to be thrown
@@ -145,8 +140,9 @@ public interface PropertyValue {
* call chaining.
* </p>
*
- * @param flowFile
- * @return
+ * @param flowFile to evaluate attributes of
+ * @return a PropertyValue with the new value is returned, supporting call
+ * chaining
*
* @throws ProcessException if the Query cannot be compiled or evaluating
* the query against the given attributes causes an Exception to be thrown
@@ -161,8 +157,10 @@ public interface PropertyValue {
* supporting call chaining.
* </p>
*
- * @param decorator
- * @return
+ * @param decorator The supplied decorator is then given a chance to
+ * decorate the value
+ * @return a PropertyValue with the new value is then returned, supporting
+ * call chaining
*
* @throws ProcessException if the Query cannot be compiled or evaluating
* the query against the given attributes causes an Exception to be thrown
@@ -177,10 +175,12 @@ public interface PropertyValue {
* supporting call chaining.
* </p>
*
- * @param flowFile
- * @param decorator
+ * @param flowFile to evaluate expressions against
+ * @param decorator The supplied decorator is then given a chance to
+ * decorate the value
*
- * @return
+ * @return a PropertyValue with the new value is then returned, supporting
+ * call chaining
*
* @throws ProcessException if the Query cannot be compiled or evaluating
* the query against the given attributes causes an Exception to be thrown
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationContext.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationContext.java
index 61b68a2..a1dcf43 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationContext.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationContext.java
@@ -25,86 +25,71 @@ import org.apache.nifi.expression.ExpressionLanguageCompiler;
public interface ValidationContext {
/**
- * Returns the {@link ControllerServiceLookup} which can be used to obtain
+ * @return the {@link ControllerServiceLookup} which can be used to obtain
* Controller Services
- *
- * @return
*/
ControllerServiceLookup getControllerServiceLookup();
/**
- * Returns a ValidationContext that is appropriate for validating the given
+ * @param controllerService to lookup the validation context of
+ * @return a ValidationContext that is appropriate for validating the given
* {@link ControllerService}
- *
- * @param controllerService
- * @return
*/
ValidationContext getControllerServiceValidationContext(ControllerService controllerService);
/**
- * Creates and returns a new {@link ExpressionLanguageCompiler} that can be
- * used to compile & evaluate Attribute Expressions
- *
- * @return
+ * @return a new {@link ExpressionLanguageCompiler} that can be used to
+ * compile & evaluate Attribute Expressions
*/
ExpressionLanguageCompiler newExpressionLanguageCompiler();
/**
- * Returns a PropertyValue that encapsulates the value configured for the
+ * @param property being validated
+ * @return a PropertyValue that encapsulates the value configured for the
* given PropertyDescriptor
- *
- * @param property
- * @return
*/
PropertyValue getProperty(PropertyDescriptor property);
/**
- * Returns a PropertyValue that represents the given value
- *
- * @param value
- * @return
+ * @param value to make a PropertyValue object for
+ * @return a PropertyValue that represents the given value
*/
PropertyValue newPropertyValue(String value);
/**
- * Returns a Map of all configured Properties.
- *
- * @return
+ * @return a Map of all configured Properties
*/
Map<PropertyDescriptor, String> getProperties();
/**
- * Returns the currently configured Annotation Data
- *
- * @return
+ * @return the currently configured Annotation Data
*/
String getAnnotationData();
-
+
/**
- * There are times when the framework needs to consider a component valid, even if it
- * references an invalid ControllerService. This method will return <code>false</code>
- * if the component is to be considered valid even if the given Controller Service is referenced
- * and is invalid.
- * @param service
+ * There are times when the framework needs to consider a component valid,
+ * even if it references an invalid ControllerService. This method will
+ * return <code>false</code> if the component is to be considered valid even
+ * if the given Controller Service is referenced and is invalid.
+ *
+ * @param service to check if validation is required
+ * @return <code>false</code> if the component is to be considered valid
+ * even if the given Controller Service is referenced and is invalid
*/
boolean isValidationRequired(ControllerService service);
-
+
/**
- * Returns <code>true</code> if the given value contains a NiFi Expression Language expression,
- * <code>false</code> if it does not
- *
- * @param value
- * @return
+ * @param value to test whether expression language is present
+ * @return <code>true</code> if the given value contains a NiFi Expression
+ * Language expression, <code>false</code> if it does not
*/
boolean isExpressionLanguagePresent(String value);
-
+
/**
- * Returns <code>true</code> if the property with the given name supports the NiFi Expression Language,
- * <code>false</code> if the property does not support the Expression Language or is not a valid property
- * name
- *
- * @param propertyName
- * @return
+ * @param propertyName to test whether expression language is supported
+ * @return <code>true</code> if the property with the given name supports
+ * the NiFi Expression Language, <code>false</code> if the property does not
+ * support the Expression Language or is not a valid property name
*/
boolean isExpressionLanguageSupported(String propertyName);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationResult.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationResult.java b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationResult.java
index 3a54848..2736044 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationResult.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/components/ValidationResult.java
@@ -119,8 +119,8 @@ public class ValidationResult {
/**
* Defaults to false
*
- * @param valid
- * @return
+ * @param valid true if is valid; false otherwise
+ * @return the builder
*/
public Builder valid(final boolean valid) {
this.valid = valid;
@@ -130,8 +130,8 @@ public class ValidationResult {
/**
* Defaults to empty string
*
- * @param input
- * @return
+ * @param input what was validated
+ * @return the builder
*/
public Builder input(final String input) {
if (null != input) {
@@ -143,8 +143,8 @@ public class ValidationResult {
/**
* Defaults to empty string
*
- * @param explanation
- * @return
+ * @param explanation of validation result
+ * @return the builder
*/
public Builder explanation(final String explanation) {
if (null != explanation) {
@@ -156,8 +156,8 @@ public class ValidationResult {
/**
* Defaults to empty string
*
- * @param subject
- * @return
+ * @param subject the thing that was validated
+ * @return the builder
*/
public Builder subject(final String subject) {
if (null != subject) {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/AbstractControllerService.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/AbstractControllerService.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/AbstractControllerService.java
index 71cdd23..cd3b9bd 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/AbstractControllerService.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/AbstractControllerService.java
@@ -32,7 +32,7 @@ public abstract class AbstractControllerService extends AbstractConfigurableComp
private ControllerServiceLookup serviceLookup;
private volatile ConfigurationContext configContext;
private ComponentLog logger;
-
+
@Override
public final void initialize(final ControllerServiceInitializationContext context) throws InitializationException {
this.identifier = context.getIdentifier();
@@ -52,31 +52,25 @@ public abstract class AbstractControllerService extends AbstractConfigurableComp
}
/**
- * Returns the currently configured value for the given
+ * @param descriptor to retrieve value of
+ * @return the currently configured value for the given
* {@link PropertyDescriptor}
- *
- * @param descriptor
- * @return
*/
protected final PropertyValue getProperty(final PropertyDescriptor descriptor) {
return configContext.getProperty(descriptor);
}
/**
- * Returns an unmodifiable map of all configured properties for this
+ * @return an unmodifiable map of all configured properties for this
* {@link ControllerService}
- *
- * @return
*/
protected final Map<PropertyDescriptor, String> getProperties() {
return configContext.getProperties();
}
/**
- * Returns the {@link ControllerServiceLookup} that was passed to the
+ * @return the {@link ControllerServiceLookup} that was passed to the
* {@link #init(ProcessorInitializationContext)} method
- *
- * @return
*/
protected final ControllerServiceLookup getControllerServiceLookup() {
return serviceLookup;
@@ -86,15 +80,15 @@ public abstract class AbstractControllerService extends AbstractConfigurableComp
* Provides a mechanism by which subclasses can perform initialization of
* the Reporting Task before it is scheduled to be run
*
- * @param config
- * @throws InitializationException
+ * @param config of initialization context
+ * @throws InitializationException if unable to init
*/
protected void init(final ControllerServiceInitializationContext config) throws InitializationException {
}
-
+
/**
- * Returns the logger that has been provided to the component by the framework in its initialize method.
- * @return
+ * @return the logger that has been provided to the component by the
+ * framework in its initialize method
*/
protected ComponentLog getLogger() {
return logger;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ConfigurationContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
index 7ed0917..1fff6b9 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ConfigurationContext.java
@@ -28,18 +28,14 @@ import org.apache.nifi.components.PropertyValue;
public interface ConfigurationContext {
/**
- * Returns the configured value for the property with the given name
- *
- * @param property
- * @return
+ * @param property to retrieve by name
+ * @return the configured value for the property with the given name
*/
PropertyValue getProperty(PropertyDescriptor property);
/**
- * Returns an unmodifiable map of all configured properties for this
+ * @return an unmodifiable map of all configured properties for this
* {@link ControllerService}
- *
- * @return
*/
Map<PropertyDescriptor, String> getProperties();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java
index cbf81a5..a77c69d 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerService.java
@@ -68,21 +68,20 @@ import org.apache.nifi.reporting.ReportingTask;
* </p>
* <p>
* <code><pre>
- * public static final PropertyDescriptor MY_PROPERTY = new PropertyDescriptor.Builder()
- * .name("My Property")
- * .description("Example Property")
- * .identifiesControllerService( MyControllerServiceInterface.class )
- * .build();
+ * public static final PropertyDescriptor MY_PROPERTY = new PropertyDescriptor.Builder()
+ * .name("My Property")
+ * .description("Example Property")
+ * .identifiesControllerService( MyControllerServiceInterface.class )
+ * .build();
*
- * ...
+ * ...
+ * public void onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) throws ProcessException {
+ * // Obtain the user-selected controller service
+ * final MyControllerServiceInterface service = context.getProperty(MY_PROPERTY).asControllerService( MyControllerServiceInterface.class );
+ * ...
+ * }
*
- * public void onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) throws ProcessException {
- * // Obtain the user-selected controller service
- * final MyControllerServiceInterface service = context.getProperty(MY_PROPERTY).asControllerService( MyControllerServiceInterface.class );
- * ...
- * }
- *
- * </pre></code></p>
+ * </pre></code></p>
* </li>
* <li>A Controller Service can be obtained via a
* {@link ControllerServiceLookup}. This lookup may be obtained, for example,
@@ -94,10 +93,9 @@ import org.apache.nifi.reporting.ReportingTask;
* </p>
* <p>
* <code><pre>
- * public void onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) throws ProcessException {
- * final MyControllerServiceInterface service = (MyControllerServiceInterface)
- * context.getControllerServiceLookup().getControllerService("service_identifier");
- * }
+ * public void onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) throws ProcessException {
+ * final MyControllerServiceInterface service = (MyControllerServiceInterface) context.getControllerServiceLookup().getControllerService("service_identifier");
+ * }
* </pre></code></p>
* </li>
* </ul>
@@ -142,12 +140,12 @@ import org.apache.nifi.reporting.ReportingTask;
* <p>
* Typically, this is done by creating a NAR structure as follows:
* <pre>
- * + my-services-api-nar
- * +--- service-X-implementation-nar
- * +--- service-Y-implementation-nar
- * +--- service-Z-implementation-nar
- * +--- processor-A-nar
- * +--- processor-B-nar
+ * + my-services-api-nar
+ * +--- service-X-implementation-nar
+ * +--- service-Y-implementation-nar
+ * +--- service-Z-implementation-nar
+ * +--- processor-A-nar
+ * +--- processor-B-nar
* </pre>
* </p>
*
@@ -174,8 +172,8 @@ public interface ControllerService extends ConfigurableComponent {
* throughout the life of the service. This method will be called before any
* properties are set
*
- * @param context
- * @throws org.apache.nifi.reporting.InitializationException
+ * @param context of initialization
+ * @throws org.apache.nifi.reporting.InitializationException if unable to init
*/
void initialize(ControllerServiceInitializationContext context) throws InitializationException;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceInitializationContext.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceInitializationContext.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceInitializationContext.java
index d34c635..6fcee0c 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceInitializationContext.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceInitializationContext.java
@@ -21,26 +21,20 @@ import org.apache.nifi.logging.ComponentLog;
public interface ControllerServiceInitializationContext {
/**
- * Returns the identifier associated with the {@link ControllerService} with
+ * @return the identifier associated with the {@link ControllerService} with
* which this context is associated
- *
- * @return
*/
String getIdentifier();
/**
- * Returns the {@link ControllerServiceLookup} which can be used to obtain
+ * @return the {@link ControllerServiceLookup} which can be used to obtain
* Controller Services
- *
- * @return
*/
ControllerServiceLookup getControllerServiceLookup();
-
+
/**
- * Returns a logger that can be used to log important events in a standard way and generate
- * bulletins when appropriate
- *
- * @return
+ * @return a logger that can be used to log important events in a standard
+ * way and generate bulletins when appropriate
*/
ComponentLog getLogger();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceLookup.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceLookup.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceLookup.java
index 4b96f62..f5300b1 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceLookup.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/ControllerServiceLookup.java
@@ -18,68 +18,53 @@ package org.apache.nifi.controller;
import java.util.Set;
-
public interface ControllerServiceLookup {
/**
- * Returns the ControllerService that is registered with the given
+ * @param serviceIdentifier of controller service
+ * @return the ControllerService that is registered with the given
* identifier
- *
- * @param serviceIdentifier
- * @return
*/
ControllerService getControllerService(String serviceIdentifier);
/**
- * Returns <code>true</code> if the Controller Service with the given
+ * @param serviceIdentifier identifier of service to check
+ * @return <code>true</code> if the Controller Service with the given
* identifier is enabled, <code>false</code> otherwise. If the given
* identifier is not known by this ControllerServiceLookup, returns
* <code>false</code>
- *
- * @param serviceIdentifier
- * @return
*/
boolean isControllerServiceEnabled(String serviceIdentifier);
/**
- * Returns <code>true</code> if the Controller Service with the given
+ * @param serviceIdentifier idenfitier of service to check
+ * @return <code>true</code> if the Controller Service with the given
* identifier has been enabled but is still in the transitioning state,
- * otherwise returns <code>false</code>.
- * If the given identifier is not known by this ControllerServiceLookup,
- * returns <code>false</code>.
- *
- * @param serviceIdentifier
- * @return
+ * otherwise returns <code>false</code>. If the given identifier is not
+ * known by this ControllerServiceLookup, returns <code>false</code>
*/
boolean isControllerServiceEnabling(String serviceIdentifier);
-
+
/**
- * Returns <code>true</code> if the given Controller Service is enabled,
+ * @param service service to check
+ * @return <code>true</code> if the given Controller Service is enabled,
* <code>false</code> otherwise. If the given Controller Service is not
* known by this ControllerServiceLookup, returns <code>false</code>
- *
- * @param service
- * @return
*/
boolean isControllerServiceEnabled(ControllerService service);
/**
- * Returns the set of all Controller Service Identifiers whose Controller
- * Service is of the given type. The class specified MUST be an interface,
- * or an IllegalArgumentExcption will be thrown
- *
- * @param serviceType
- * @return
- *
+ * @param serviceType type of service to get identifiers for
+ * @return the set of all Controller Service Identifiers whose Controller
+ * Service is of the given type.
* @throws IllegalArgumentException if the given class is not an interface
*/
Set<String> getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType) throws IllegalArgumentException;
/**
- * Returns the name of the Controller service with the given identifier. If no service can be
- * found with this identifier, returns {@code null}.
- * @param serviceIdentifier
- * @return
+ * @param serviceIdentifier identifier to look up
+ * @return the name of the Controller service with the given identifier. If
+ * no service can be found with this identifier, returns {@code null}
*/
String getControllerServiceName(String serviceIdentifier);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/FlowFileQueue.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/FlowFileQueue.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/FlowFileQueue.java
index 86742c7..92a4ee0 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/FlowFileQueue.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/FlowFileQueue.java
@@ -40,10 +40,8 @@ public interface FlowFileQueue {
List<FlowFilePrioritizer> getPriorities();
/**
- * Returns the minimum number of FlowFiles that must be present in order for
+ * @return the minimum number of FlowFiles that must be present in order for
* FlowFiles to begin being swapped out of the queue
- *
- * @return
*/
int getSwapThreshold();
@@ -71,9 +69,7 @@ public interface FlowFileQueue {
long getBackPressureObjectThreshold();
/**
- * Establishes this queue's preferred maximum data size.
- *
- * @param maxDataSize
+ * @param maxDataSize Establishes this queue's preferred maximum data size.
*/
void setBackPressureDataSizeThreshold(String maxDataSize);
@@ -117,21 +113,21 @@ public interface FlowFileQueue {
/**
* places the given file into the queue
*
- * @param file
+ * @param file to place into queue
*/
void put(FlowFileRecord file);
/**
* places the given files into the queue
*
- * @param files
+ * @param files to place into queue
*/
void putAll(Collection<FlowFileRecord> files);
/**
* Removes all records from the internal swap queue and returns them.
*
- * @return
+ * @return all removed records from internal swap queue
*/
List<FlowFileRecord> pollSwappableRecords();
@@ -139,7 +135,7 @@ public interface FlowFileQueue {
* Restores the records from swap space into this queue, adding the records
* that have expired to the given set instead of enqueuing them.
*
- * @param records
+ * @param records that were swapped in
*/
void putSwappedRecords(Collection<FlowFileRecord> records);
@@ -147,15 +143,13 @@ public interface FlowFileQueue {
* Updates the internal counters of how much data is queued, based on
* swapped data that is being restored.
*
- * @param numRecords
- * @param contentSize
+ * @param numRecords count of records swapped in
+ * @param contentSize total size of records being swapped in
*/
void incrementSwapCount(int numRecords, long contentSize);
/**
- * Returns the number of FlowFiles that are enqueued and not swapped
- *
- * @return
+ * @return the number of FlowFiles that are enqueued and not swapped
*/
int unswappedSize();
@@ -164,14 +158,14 @@ public interface FlowFileQueue {
int getSwapQueueSize();
/**
- * @param expiredRecords
+ * @param expiredRecords expired records
* @return the next flow file on the queue; null if empty
*/
FlowFileRecord poll(Set<FlowFileRecord> expiredRecords);
/**
- * @param maxResults
- * @param expiredRecords
+ * @param maxResults limits how many results can be polled
+ * @param expiredRecords for expired records
* @return the next flow files on the queue up to the max results; null if
* empty
*/
@@ -181,10 +175,10 @@ public interface FlowFileQueue {
* Drains flow files from the given source queue into the given destination
* list.
*
- * @param sourceQueue
- * @param destination
+ * @param sourceQueue queue to drain from
+ * @param destination Collection to drain to
* @param maxResults max number to drain
- * @param expiredRecords
+ * @param expiredRecords for expired records
* @return size (bytes) of flow files drained from queue
*/
long drainQueue(Queue<FlowFileRecord> sourceQueue, List<FlowFileRecord> destination, int maxResults, Set<FlowFileRecord> expiredRecords);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Snippet.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Snippet.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Snippet.java
index 8ce106e..93f3327 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Snippet.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Snippet.java
@@ -24,89 +24,65 @@ import java.util.Set;
public interface Snippet {
/**
- * The id of this snippet.
- *
- * @return
+ * @return id of this snippet
*/
public String getId();
/**
- * Whether or not this snippet is linked to the data flow. If the Snippet is
+ * @return Whether or not this snippet is linked to the data flow. If the Snippet is
* deleted and is linked, then the underlying components will also be
* deleted. If the Snippet is deleted and is NOT linked, only the Snippet is
* removed
- *
- * @return
*/
public boolean isLinked();
/**
- * The parent group id of the components in this snippet.
- *
- * @return
+ * @return parent group id of the components in this snippet
*/
public String getParentGroupId();
/**
- * The connections in this snippet.
- *
- * @return
+ * @return connections in this snippet
*/
public Set<String> getConnections();
/**
- * The funnels in this snippet.
- *
- * @return
+ * @return funnels in this snippet
*/
public Set<String> getFunnels();
/**
- * The input ports in this snippet.
- *
- * @return
+ * @return input ports in this snippet
*/
public Set<String> getInputPorts();
/**
- * The output ports in this snippet.
- *
- * @return
+ * @return output ports in this snippet
*/
public Set<String> getOutputPorts();
/**
- * The labels in this snippet.
- *
- * @return
+ * @return labels in this snippet
*/
public Set<String> getLabels();
/**
- * Returns the identifiers of all ProcessGroups in this Snippet
- *
- * @return
+ * @return the identifiers of all ProcessGroups in this Snippet
*/
public Set<String> getProcessGroups();
/**
- * Returns the identifiers of all Processors in this Snippet
- *
- * @return
+ * @return the identifiers of all Processors in this Snippet
*/
public Set<String> getProcessors();
/**
- * Returns the identifiers of all RemoteProcessGroups in this Snippet
- *
- * @return
+ * @return the identifiers of all RemoteProcessGroups in this Snippet
*/
public Set<String> getRemoteProcessGroups();
/**
- * Determines if this snippet is empty.
- *
- * @return
+ * @return Determines if this snippet is empty
*/
public boolean isEmpty();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Triggerable.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Triggerable.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Triggerable.java
index 2eba911..4b3149b 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Triggerable.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/Triggerable.java
@@ -44,9 +44,9 @@ public interface Triggerable {
* be committed or the framework may use the session again for another
* processor down stream</p>
*
- * @param context
- * @param sessionFactory used to generate {@link ProcessSession}s to use
- * for operating on flow files within the repository
+ * @param context in which the component is triggered
+ * @param sessionFactory used to generate {@link ProcessSession}s to use for
+ * operating on flow files within the repository
*
* @throws ProcessException if processing did not complete normally though
* indicates the problem is an understood potential outcome of processing.
@@ -81,7 +81,7 @@ public interface Triggerable {
* <code>Triggerable</code> has any active threads, see
* {@link ProcessScheduler#getActiveThreadCount(nifi.connectable.Connectable)}.
*
- * @return
+ * @return the schedule state
*/
ScheduledState getScheduledState();
@@ -92,12 +92,12 @@ public interface Triggerable {
* invocation of {@link #onTrigger(ProcessContext, ProcessSessionFactory)}
* have not yet returned
*
- * @return
+ * @return true if running;false otherwise
*/
boolean isRunning();
/**
- * @param timeUnit
+ * @param timeUnit for the scheduling period of the component
* @return the amount of time between each scheduling period
*/
long getSchedulingPeriod(TimeUnit timeUnit);
@@ -110,7 +110,8 @@ public interface Triggerable {
/**
* Updates how often this Triggerable should be triggered to run
- * @param schedulingPeriod
+ *
+ * @param schedulingPeriod to set
*/
void setScheduldingPeriod(String schedulingPeriod);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java
index 78cc04b..2aa90cc 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java
@@ -31,8 +31,9 @@ import java.lang.annotation.Target;
* {@link nifi.controller.ConfigurationContext ConfigurationContext}.
*
* @author none
- *
- * @deprecated This annotation has been replaced by those in the {@link org.apache.nifi.annotation.lifecycle} package.
+ *
+ * @deprecated This annotation has been replaced by those in the
+ * {@link org.apache.nifi.annotation.lifecycle} package.
*/
@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/controller/repository/ContentRepository.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/ContentRepository.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/ContentRepository.java
index d66b8a6..ee3ead9 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/ContentRepository.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/ContentRepository.java
@@ -31,7 +31,6 @@ import org.apache.nifi.controller.repository.claim.ContentClaimManager;
* available on the methods but a merge capability is provided which between
* that and creating new claims a merge is available.
*
- * @author none
*/
public interface ContentRepository {
@@ -40,46 +39,38 @@ public interface ContentRepository {
* ContentClaimManager that is to be used for interacting with Content
* Claims
*
- * @param claimManager
- * @throws java.io.IOException
+ * @param claimManager to handle claims
+ * @throws java.io.IOException if unable to init
*/
void initialize(ContentClaimManager claimManager) throws IOException;
/**
- * Shuts down the Content Repository, freeing any resources that may be held.
- * This is called when an administrator shuts down NiFi.
+ * Shuts down the Content Repository, freeing any resources that may be
+ * held. This is called when an administrator shuts down NiFi.
*/
void shutdown();
-
+
/**
- * Returns the names of all Containers that exist for this Content
+ * @return the names of all Containers that exist for this Content
* Repository
- *
- * @return
*/
Set<String> getContainerNames();
/**
- * Returns the maximum number of bytes that can be stored in the storage
+ * @param containerName name of container to check capacity on
+ * @return the maximum number of bytes that can be stored in the storage
* mechanism that backs the container with the given name
- *
- * @param containerName
- * @return
- * @throws java.io.IOException
- *
+ * @throws java.io.IOException if unable to check capacity
* @throws IllegalArgumentException if no container exists with the given
* name
*/
long getContainerCapacity(String containerName) throws IOException;
/**
- * Returns the number of bytes available to be used used by the storage
+ * @param containerName to check space on
+ * @return the number of bytes available to be used used by the storage
* mechanism that backs the container with the given name
- *
- * @param containerName
- * @return
- * @throws java.io.IOException
- *
+ * @throws java.io.IOException if unable to check space
* @throws IllegalArgumentException if no container exists with the given
* name
*/
@@ -92,14 +83,14 @@ public interface ContentRepository {
* loss tolerant. If true the repository might choose more volatile storage
* options which could increase performance for a tradeoff with reliability
* @return newly created claim
- * @throws java.io.IOException
+ * @throws java.io.IOException if unable to create claim
*/
ContentClaim create(boolean lossTolerant) throws IOException;
/**
* Increments the number of claimants for the given claim
*
- * @param claim
+ * @param claim to increment
* @return the number of claimants after incrementing
*/
int incrementClaimaintCount(ContentClaim claim);
@@ -107,7 +98,7 @@ public interface ContentRepository {
/**
* Obtains the current number of claimants for the given claim
*
- * @param claim
+ * @param claim to get count of
* @return the number of claimants
*/
int getClaimantCount(ContentClaim claim);
@@ -117,15 +108,15 @@ public interface ContentRepository {
* claim is null or content cannot be found or removed no exception will be
* thrown.
*
- * @param claim
- * @return
+ * @param claim to decrement
+ * @return new claimant count for the given claim
*/
int decrementClaimantCount(ContentClaim claim);
/**
* Removes the content indicated by the given claim
*
- * @param claim
+ * @param claim to remove
*
* @return a boolean indicating whether or not the destruction of the claim
* was successful
@@ -136,9 +127,9 @@ public interface ContentRepository {
* Clones the content for the given content claim and returns content claim
* of the new object
*
- * @param original
- * @param lossTolerant
- * @return
+ * @param original to clone
+ * @param lossTolerant if can be place in a loss tolerant repository
+ * @return new claim
* @throws IOException if an IO error occurs. Any content written to the new
* destination prior to the error will be destroyed
*/
@@ -156,7 +147,7 @@ public interface ContentRepository {
* @param footer if supplied will be appended to the output
* @param demarcator if supplied will be placed in between each merged
* object
- * @throws IOException
+ * @throws IOException if unable to merge
* @throws IllegalArgumentException if the given destination is included in
* the given claims
*/
@@ -167,9 +158,9 @@ public interface ContentRepository {
* claim within the repository.
*
* @return the size of the claim
- * @param content
+ * @param content to import from
* @param claim the claim to write imported content to
- * @throws IOException
+ * @throws IOException if failure to read given content
*/
long importFrom(Path content, ContentClaim claim) throws IOException;
@@ -179,11 +170,11 @@ public interface ContentRepository {
* argument
*
* @return the size of the claim
- * @param content
+ * @param content to import from
* @param claim the claim to write imported content to
* @param append if true, the content will be appended to the claim; if
* false, the content will replace the contents of the claim
- * @throws IOException
+ * @throws IOException if unable to read content
*/
long importFrom(Path content, ContentClaim claim, boolean append) throws IOException;
@@ -192,9 +183,9 @@ public interface ContentRepository {
* claim within the repository.
*
* @return the size of the claim
- * @param content
+ * @param content to import from
* @param claim the claim to write imported content to
- * @throws IOException
+ * @throws IOException if unable to read content
*/
long importFrom(InputStream content, ContentClaim claim) throws IOException;
@@ -202,11 +193,11 @@ public interface ContentRepository {
* Imports content from the given stream, appending or replacing the current
* claim, according to the value of the appen dargument
*
- * @param content
- * @param claim
- * @param append
- * @return
- * @throws IOException
+ * @param content to import from
+ * @param claim to write to
+ * @param append whether to append or replace
+ * @return length of data imported in bytes
+ * @throws IOException if failure to read or write stream
*/
long importFrom(InputStream content, ContentClaim claim, boolean append) throws IOException;
@@ -214,7 +205,7 @@ public interface ContentRepository {
* Exports the content of the given claim to the given destination.
*
* @return the size of the destination or the claim
- * @param claim
+ * @param claim to export from
* @param destination where to export data
* @param append if true appends to the destination; false overwrites
* @throws IOException if an IO error occurs. The state of the content for
@@ -227,7 +218,7 @@ public interface ContentRepository {
* Exports the content of the given claim to the given destination.
*
* @return the size of the destination or the claim
- * @param claim
+ * @param claim to export from
* @param destination where to export data
* @param append if true appends to the destination; false overwrites
* @param offset the offset at which the claim should start being copied
@@ -242,7 +233,7 @@ public interface ContentRepository {
* Exports the content of the given claim to the given destination.
*
* @return the size of the claim
- * @param claim
+ * @param claim to export from
* @param destination where to export data
* @throws IOException if an IO error occurs.
*/
@@ -253,7 +244,7 @@ public interface ContentRepository {
* and copying length bytes, to the given destination.
*
* @return the number of bytes copied
- * @param claim
+ * @param claim to export from
* @param destination where to export data
* @param offset the offset into the claim at which the copy should begin
* @param length the number of bytes to copy
@@ -262,27 +253,27 @@ public interface ContentRepository {
long exportTo(ContentClaim claim, OutputStream destination, long offset, long length) throws IOException;
/**
- * @param claim
+ * @param claim to get size of
* @return size in bytes of content for given claim
- * @throws IOException
+ * @throws IOException if size check failed
*/
long size(ContentClaim claim) throws IOException;
/**
* Provides access to the input stream for the given claim
*
- * @param claim
+ * @param claim to read from
* @return InputStream over the content of the given claim
- * @throws IOException
+ * @throws IOException if unable to read
*/
InputStream read(ContentClaim claim) throws IOException;
/**
* Obtains an OutputStream to the content for the given claim.
*
- * @param claim
- * @return
- * @throws IOException
+ * @param claim to write to
+ * @return the stream to write to
+ * @throws IOException if unable to obtain stream
*/
OutputStream write(ContentClaim claim) throws IOException;
@@ -300,15 +291,13 @@ public interface ContentRepository {
void cleanup();
/**
- * Returns a boolean indicating whether or not the content specified by the
- * given claim can be read, regardless of whether the content has been
- * archived or not. If the ContentRepository does not implement archiving
- * capabilities, this method will return <code>false</code>.
- *
* @param contentClaim the Content Claim to check
- * @return
+ * @return Returns a boolean indicating whether or not the content specified
+ * by the given claim can be read, regardless of whether the content has
+ * been archived or not. If the ContentRepository does not implement
+ * archiving capabilities, this method will return <code>false</code>
*
- * @throws IOException
+ * @throws IOException if unable to determine accessibility
*/
boolean isAccessible(ContentClaim contentClaim) throws IOException;
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java
index 13548a2..f2493f6 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java
@@ -27,28 +27,22 @@ import org.apache.nifi.flowfile.FlowFile;
public interface FlowFileRecord extends FlowFile {
/**
- * Returns the time (in millis since epoch) at which this FlowFile should no
- * longer be penalized.
- *
- * @return
+ * @return the time (in millis since epoch) at which this FlowFile should no
+ * longer be penalized
*/
long getPenaltyExpirationMillis();
/**
- * Returns the {@link ContentClaim} that holds the FlowFile's content
- *
- * @return
+ * @return the {@link ContentClaim} that holds the FlowFile's content
*/
ContentClaim getContentClaim();
/**
- * Returns the byte offset into the {@link ContentClaim} at which the
+ * @return the byte offset into the {@link ContentClaim} at which the
* FlowFile's content occurs. This mechanism allows multiple FlowFiles to
* have the same ContentClaim, which can be significantly more efficient for
* some implementations of
* {@link nifi.controller.repository.ContentRepository ContentRepository}
- *
- * @return
*/
long getContentClaimOffset();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRepository.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRepository.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRepository.java
index 999a087..5e59e04 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRepository.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRepository.java
@@ -27,7 +27,6 @@ import org.apache.nifi.controller.repository.claim.ContentClaimManager;
/**
* Implementations must be thread safe
*
- * @author none
*/
public interface FlowFileRepository extends Closeable {
@@ -36,28 +35,24 @@ public interface FlowFileRepository extends Closeable {
* ContentClaimManager that is to be used for interacting with Content
* Claims
*
- * @param claimManager
- * @throws java.io.IOException
+ * @param claimManager for handling claims
+ * @throws java.io.IOException if unable to initialize repository
*/
void initialize(ContentClaimManager claimManager) throws IOException;
/**
- * Returns the maximum number of bytes that can be stored in the underlying
+ * @return the maximum number of bytes that can be stored in the underlying
* storage mechanism
*
- * @return
- *
- * @throws IOException
+ * @throws IOException if computing capacity fails
*/
long getStorageCapacity() throws IOException;
/**
- * Returns the number of bytes currently available for use by the underlying
+ * @return the number of bytes currently available for use by the underlying
* storage mechanism
*
- * @return
- *
- * @throws IOException
+ * @throws IOException if computing usable space fails
*/
long getUsableStorageSpace() throws IOException;
@@ -65,7 +60,7 @@ public interface FlowFileRepository extends Closeable {
* Updates the repository with the given RepositoryRecords.
*
* @param records the records to update the repository with
- * @throws java.io.IOException
+ * @throws java.io.IOException if update fails
*/
void updateRepository(Collection<RepositoryRecord> records) throws IOException;
@@ -79,7 +74,7 @@ public interface FlowFileRepository extends Closeable {
* returned by a call to {@link #getNextFlowFileSequence()}
*
* @return index of highest flow file identifier
- * @throws IOException
+ * @throws IOException if load fails
*/
long loadFlowFiles(QueueProvider queueProvider, long minimumSequenceNumber) throws IOException;
@@ -97,7 +92,7 @@ public interface FlowFileRepository extends Closeable {
/**
* @return the max ID of all <code>FlowFile</code>s that currently exist in
* the repository.
- * @throws IOException
+ * @throws IOException if computing max identifier fails
*/
long getMaxFlowFileIdentifier() throws IOException;
@@ -109,7 +104,7 @@ public interface FlowFileRepository extends Closeable {
* @param flowFileQueue the queue that the FlowFiles belong to
* @param swapLocation the location to which the FlowFiles were swapped
*
- * @throws IOException
+ * @throws IOException if swap fails
*/
void swapFlowFilesOut(List<FlowFileRecord> swappedOut, FlowFileQueue flowFileQueue, String swapLocation) throws IOException;
@@ -122,7 +117,7 @@ public interface FlowFileRepository extends Closeable {
* @param flowFileRecords the records that were swapped in
* @param flowFileQueue the queue that the FlowFiles belong to
*
- * @throws IOException
+ * @throws IOException if swap fails
*/
void swapFlowFilesIn(String swapLocation, List<FlowFileRecord> flowFileRecords, FlowFileQueue flowFileQueue) throws IOException;
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileSwapManager.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileSwapManager.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileSwapManager.java
index c6daab8..869e2b3 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileSwapManager.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileSwapManager.java
@@ -55,9 +55,9 @@ public interface FlowFileSwapManager {
* Notifies FlowFile queues of the number of FlowFiles and content size of
* all FlowFiles that are currently swapped out
*
- * @param connectionProvider
- * @param claimManager
- * @return
+ * @param connectionProvider provider
+ * @param claimManager manager
+ * @return how many flowfiles have been recovered
*/
long recoverSwappedFlowFiles(QueueProvider connectionProvider, ContentClaimManager claimManager);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/QueueProvider.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/QueueProvider.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/QueueProvider.java
index 42cf319..fcb516d 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/QueueProvider.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/QueueProvider.java
@@ -27,9 +27,7 @@ import org.apache.nifi.controller.FlowFileQueue;
public interface QueueProvider {
/**
- * Returns all <code>FlowFileQueue</code>s that currently exist in the flow
- *
- * @return
+ * @return all <code>FlowFileQueue</code>s that currently exist in the flow
*/
Collection<FlowFileQueue> getAllQueues();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/RepositoryRecord.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/RepositoryRecord.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/RepositoryRecord.java
index d4b9c86..40d44a8 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/RepositoryRecord.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/RepositoryRecord.java
@@ -26,60 +26,44 @@ import org.apache.nifi.controller.repository.claim.ContentClaim;
public interface RepositoryRecord {
/**
- * The FlowFileQueue to which the FlowFile is to be transferred
- *
- * @return
+ * @return FlowFileQueue to which the FlowFile is to be transferred
*/
FlowFileQueue getDestination();
/**
- * The FlowFileQueue from which the record was pulled
- *
- * @return
+ * @return FlowFileQueue from which the record was pulled
*/
FlowFileQueue getOriginalQueue();
/**
- * The type of update that this record encapsulates
- *
- * @return
+ * @return type of update that this record encapsulates
*/
RepositoryRecordType getType();
/**
- * The current ContentClaim for the FlowFile
- *
- * @return
+ * @return current ContentClaim for the FlowFile
*/
ContentClaim getCurrentClaim();
/**
- * The original ContentClaim for the FlowFile before any changes were made
- *
- * @return
+ * @return original ContentClaim for the FlowFile before any changes were made
*/
ContentClaim getOriginalClaim();
/**
- * The byte offset into the Content Claim where this FlowFile's content
+ * @return byte offset into the Content Claim where this FlowFile's content
* begins
- *
- * @return
*/
long getCurrentClaimOffset();
/**
- * The FlowFile being encapsulated by this record
- *
- * @return
+ * @return FlowFile being encapsulated by this record
*/
FlowFileRecord getCurrent();
/**
- * Whether or not the FlowFile's attributes have changed since the FlowFile
+ * @return Whether or not the FlowFile's attributes have changed since the FlowFile
* was pulled from its queue (or created)
- *
- * @return
*/
boolean isAttributesChanged();
@@ -90,11 +74,9 @@ public interface RepositoryRecord {
boolean isMarkedForAbort();
/**
- * If the FlowFile is swapped out of the Java heap space, provides the
+ * @return If the FlowFile is swapped out of the Java heap space, provides the
* location of the swap file, or <code>null</code> if the FlowFile is not
* swapped out
- *
- * @return
*/
String getSwapLocation();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaim.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaim.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaim.java
index e321217..11a1620 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaim.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaim.java
@@ -45,11 +45,9 @@ public interface ContentClaim extends Comparable<ContentClaim> {
String getSection();
/**
- * Specifies whether or not the Claim is loss-tolerant. If so, we will
+ * @return Indicates whether or not the Claim is loss-tolerant. If so, we will
* attempt to keep the content but will not sacrifice a great deal of
- * performance to do so.
- *
- * @return
+ * performance to do so
*/
boolean isLossTolerant();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaimManager.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaimManager.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaimManager.java
index 6a5b38b..bffcec3 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaimManager.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/claim/ContentClaimManager.java
@@ -28,20 +28,18 @@ public interface ContentClaimManager {
* Creates a new Content Claim with the given id, container, section, and
* loss tolerance.
*
- * @param id
- * @param container
- * @param section
- * @param lossTolerant
- * @return
+ * @param id of claim
+ * @param container of claim
+ * @param section of claim
+ * @param lossTolerant of claim
+ * @return new claim
*/
ContentClaim newContentClaim(String container, String section, String id, boolean lossTolerant);
/**
- * Returns the number of FlowFiles that hold a claim to a particular piece
+ * @param claim to obtain reference count for
+ * @return the number of FlowFiles that hold a claim to a particular piece
* of FlowFile content
- *
- * @param claim
- * @return
*/
int getClaimantCount(ContentClaim claim);
@@ -49,8 +47,8 @@ public interface ContentClaimManager {
* Decreases by 1 the count of how many FlowFiles hold a claim to a
* particular piece of FlowFile content and returns the new count
*
- * @param claim
- * @return
+ * @param claim to decrement claimants on
+ * @return new claimaint count
*/
int decrementClaimantCount(ContentClaim claim);
@@ -58,8 +56,8 @@ public interface ContentClaimManager {
* Increases by 1 the count of how many FlowFiles hold a claim to a
* particular piece of FlowFile content and returns the new count
*
- * @param claim
- * @return
+ * @param claim to increment claims on
+ * @return new claimant count
*/
int incrementClaimantCount(ContentClaim claim);
@@ -73,9 +71,10 @@ public interface ContentClaimManager {
* optimize its tasks, knowing that the Content Claim cannot be referenced
* by any other component
*
- * @param claim
- * @param newClaim
- * @return
+ * @param claim to increment
+ * @param newClaim provides a hint that no other process can have access to this
+ * claim right now
+ * @return new claim count
*/
int incrementClaimantCount(ContentClaim claim, boolean newClaim);
@@ -105,7 +104,7 @@ public interface ContentClaimManager {
* unneeded claim. As such, it is now safe to destroy the contents.
* </p>
*
- * @param claim
+ * @param claim to mark as now destructable
*/
void markDestructable(ContentClaim claim);
@@ -114,8 +113,8 @@ public interface ContentClaimManager {
* of destructable content claims to the given {@code destination} so that
* they can be destroyed.
*
- * @param destination
- * @param maxElements
+ * @param destination to drain to
+ * @param maxElements max items to drain
*/
void drainDestructableClaims(Collection<ContentClaim> destination, int maxElements);
@@ -128,10 +127,10 @@ public interface ContentClaimManager {
* ready to be destroyed, the method will return without having added
* anything to the given {@code destination}.
*
- * @param destination
- * @param maxElements
- * @param timeout
- * @param unit
+ * @param destination to drain to
+ * @param maxElements max items to drain
+ * @param timeout maximum time to wait
+ * @param unit unit of time to wait
*/
void drainDestructableClaims(Collection<ContentClaim> destination, int maxElements, long timeout, TimeUnit unit);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/ProcessGroupStatus.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/ProcessGroupStatus.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/ProcessGroupStatus.java
index dba3a19..7aae866 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/ProcessGroupStatus.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/ProcessGroupStatus.java
@@ -425,7 +425,7 @@ public class ProcessGroupStatus implements Cloneable {
// processor run status is disabled/stopped/running is part of the flow configuration
// and should not differ amongst nodes. however, whether a processor is invalid
// can be driven by environmental conditions. this check allows any of those to
- // take precedence over the configured run status.
+ // take precedence over the configured run status.
if (RunStatus.Invalid.equals(statusToMerge.getRunStatus())) {
merged.setRunStatus(RunStatus.Invalid);
}
@@ -454,7 +454,7 @@ public class ProcessGroupStatus implements Cloneable {
merged.setTransmitting(true);
}
- // should be unnecessary here since ports run status should not be affected by
+ // should be unnecessary here since ports run status should not be affected by
// environmental conditions but doing so in case that changes
if (RunStatus.Invalid.equals(statusToMerge.getRunStatus())) {
merged.setRunStatus(RunStatus.Invalid);
@@ -484,7 +484,7 @@ public class ProcessGroupStatus implements Cloneable {
merged.setTransmitting(true);
}
- // should be unnecessary here since ports run status not should be affected by
+ // should be unnecessary here since ports run status not should be affected by
// environmental conditions but doing so in case that changes
if (RunStatus.Invalid.equals(statusToMerge.getRunStatus())) {
merged.setRunStatus(RunStatus.Invalid);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/ComponentStatusRepository.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/ComponentStatusRepository.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/ComponentStatusRepository.java
index 6fe13fc..4628a28 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/ComponentStatusRepository.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/ComponentStatusRepository.java
@@ -33,7 +33,7 @@ public interface ComponentStatusRepository {
/**
* Captures the status information provided in the given report
*
- * @param rootGroupStatus
+ * @param rootGroupStatus status of root group
*/
void capture(ProcessGroupStatus rootGroupStatus);
@@ -42,22 +42,17 @@ public interface ComponentStatusRepository {
* timestamp that indicates the time at which the status report was
* generated. This can be used to replay historical values.
*
- * @param rootGroupStatus
- * @param timestamp
+ * @param rootGroupStatus status
+ * @param timestamp timestamp of capture
*/
void capture(ProcessGroupStatus rootGroupStatus, Date timestamp);
/**
- * Returns the Date at which the latest capture was performed
- *
- * @return
+ * @return the Date at which the latest capture was performed
*/
Date getLastCaptureDate();
/**
- * Returns a {@link StatusHistory} that provides the status information
- * about the Connection with the given ID during the given time period.
- *
* @param connectionId the ID of the Connection for which the Status is
* desired
* @param start the earliest date for which status information should be
@@ -70,15 +65,13 @@ public interface ComponentStatusRepository {
* If the date range is large, the total number of data points could be far
* too many to process. Therefore, this parameter allows the requestor to
* indicate how many samples to return.
- * @return
+ * @return a {@link StatusHistory} that provides the status information
+ * about the Connection with the given ID during the given time period
*/
StatusHistory getConnectionStatusHistory(String connectionId, Date start, Date end, int preferredDataPoints);
/**
- * Returns a {@link StatusHistory} that provides the status information
- * about the Process Group with the given ID during the given time period.
- *
- * @param processGroupId
+ * @param processGroupId of group to get status of
* @param start the earliest date for which status information should be
* returned; if <code>null</code>, the start date should be assumed to be
* the beginning of time
@@ -89,15 +82,13 @@ public interface ComponentStatusRepository {
* If the date range is large, the total number of data points could be far
* too many to process. Therefore, this parameter allows the requestor to
* indicate how many samples to return.
- * @return
+ * @return a {@link StatusHistory} that provides the status information
+ * about the Process Group with the given ID during the given time period
*/
StatusHistory getProcessGroupStatusHistory(String processGroupId, Date start, Date end, int preferredDataPoints);
/**
- * Returns a {@link StatusHistory} that provides the status information
- * about the Processor with the given ID during the given time period.
- *
- * @param processorId
+ * @param processorId to get status of
* @param start the earliest date for which status information should be
* returned; if <code>null</code>, the start date should be assumed to be
* the beginning of time
@@ -108,16 +99,13 @@ public interface ComponentStatusRepository {
* If the date range is large, the total number of data points could be far
* too many to process. Therefore, this parameter allows the requestor to
* indicate how many samples to return.
- * @return
+ * @return a {@link StatusHistory} that provides the status information
+ * about the Processor with the given ID during the given time period
*/
StatusHistory getProcessorStatusHistory(String processorId, Date start, Date end, int preferredDataPoints);
/**
- * Returns a {@link StatusHistory} that provides the status information
- * about the Remote Process Group with the given ID during the given time
- * period.
- *
- * @param remoteGroupId
+ * @param remoteGroupId to get history of
* @param start the earliest date for which status information should be
* returned; if <code>null</code>, the start date should be assumed to be
* the beginning of time
@@ -128,39 +116,33 @@ public interface ComponentStatusRepository {
* If the date range is large, the total number of data points could be far
* too many to process. Therefore, this parameter allows the requestor to
* indicate how many samples to return.
- * @return
+ * @return a {@link StatusHistory} that provides the status information
+ * about the Remote Process Group with the given ID during the given time
+ * period
*/
StatusHistory getRemoteProcessGroupStatusHistory(String remoteGroupId, Date start, Date end, int preferredDataPoints);
/**
- * Returns a List of all {@link MetricDescriptor}s that are applicable to
+ * @return a List of all {@link MetricDescriptor}s that are applicable to
* Process Groups
- *
- * @return
*/
List<MetricDescriptor<ProcessGroupStatus>> getProcessGroupMetricDescriptors();
/**
- * Returns a List of all {@link MetricDescriptor}s that are applicable to
+ * @return a List of all {@link MetricDescriptor}s that are applicable to
* Processors
- *
- * @return
*/
List<MetricDescriptor<ProcessorStatus>> getProcessorMetricDescriptors();
/**
- * Returns a List of all {@link MetricDescriptor}s that are applicable to
+ * @return a List of all {@link MetricDescriptor}s that are applicable to
* Remote Process Groups
- *
- * @return
*/
List<MetricDescriptor<RemoteProcessGroupStatus>> getRemoteProcessGroupMetricDescriptors();
/**
- * Returns a List of all {@link MetricDescriptor}s that are applicable to
+ * @return a List of all {@link MetricDescriptor}s that are applicable to
* Connections
- *
- * @return
*/
List<MetricDescriptor<ConnectionStatus>> getConnectionMetricDescriptors();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/MetricDescriptor.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/MetricDescriptor.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/MetricDescriptor.java
index 3986c86..8fdce05 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/MetricDescriptor.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/MetricDescriptor.java
@@ -18,7 +18,8 @@ package org.apache.nifi.controller.status.history;
/**
* Describes a particular metric that is derived from a Status History
- * @param <T>
+ *
+ * @param <T> type of metric
*/
public interface MetricDescriptor<T> {
@@ -32,44 +33,34 @@ public interface MetricDescriptor<T> {
/**
* Specifies how the values should be formatted
*
- * @return
+ * @return formatter for values
*/
Formatter getFormatter();
/**
- * Returns a human-readable description of the field
- *
- * @return
+ * @return a human-readable description of the field
*/
String getDescription();
/**
- * Returns a human-readable label for the field
- *
- * @return
+ * @return a human-readable label for the field
*/
String getLabel();
/**
- * Returns the name of a field
- *
- * @return
+ * @return the name of a field
*/
String getField();
/**
- * Returns a {@link ValueMapper} that can be used to extract a value for the
+ * @return a {@link ValueMapper} that can be used to extract a value for the
* status history
- *
- * @return
*/
ValueMapper<T> getValueFunction();
/**
- * Returns a {@link ValueReducer} that can reduce multiple StatusSnapshots
+ * @return a {@link ValueReducer} that can reduce multiple StatusSnapshots
* into a single Long value
- *
- * @return
*/
ValueReducer<StatusSnapshot, Long> getValueReducer();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusHistory.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusHistory.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusHistory.java
index b053d33..f1bb946 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusHistory.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusHistory.java
@@ -26,25 +26,19 @@ import java.util.Map;
public interface StatusHistory {
/**
- * Returns a Date indicating when this report was generated
- *
- * @return
+ * @return a Date indicating when this report was generated
*/
Date getDateGenerated();
/**
- * Returns a Map of component field names and their values. The order in
+ * @return a Map of component field names and their values. The order in
* which these values are displayed is dependent on the natural ordering of
- * the Map returned.
- *
- * @return
+ * the Map returned
*/
Map<String, String> getComponentDetails();
/**
- * A List of snapshots for a given component
- *
- * @return
+ * @return List of snapshots for a given component
*/
List<StatusSnapshot> getStatusSnapshots();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusSnapshot.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusSnapshot.java b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusSnapshot.java
index d52c1cc..551ceb2 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusSnapshot.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/controller/status/history/StatusSnapshot.java
@@ -25,24 +25,18 @@ import java.util.Map;
public interface StatusSnapshot {
/**
- * Rreturns the point in time for which the status values were obtained
- *
- * @return
+ * @return the point in time for which the status values were obtained
*/
Date getTimestamp();
/**
- * Returns a Map of MetricDescriptor to value
- *
- * @return
+ * @return a Map of MetricDescriptor to value
*/
Map<MetricDescriptor<?>, Long> getStatusMetrics();
/**
- * Returns a {@link ValueReducer} that is capable of merging multiple
+ * @return a {@link ValueReducer} that is capable of merging multiple
* StatusSnapshot objects into a single one
- *
- * @return
*/
ValueReducer<StatusSnapshot, StatusSnapshot> getValueReducer();
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeExpression.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeExpression.java b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeExpression.java
index b71c83d..ed409ea 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeExpression.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeExpression.java
@@ -22,12 +22,10 @@ import org.apache.nifi.processor.exception.ProcessException;
public interface AttributeExpression {
/**
- * Evaluates the expression without providing any FlowFile Attributes. This
+ * @return Evaluates the expression without providing any FlowFile Attributes. This
* will evaluate the expression based only on System Properties and JVM
* Environment properties
- *
- * @return
- * @throws ProcessException
+ * @throws ProcessException if unable to evaluate
*/
String evaluate() throws ProcessException;
@@ -36,9 +34,9 @@ public interface AttributeExpression {
* will evaluate the expression based only on System Properties and JVM
* Environment properties but allows the values to be decorated
*
- * @param decorator
- * @return
- * @throws ProcessException
+ * @param decorator for attribute value
+ * @return evaluated value
+ * @throws ProcessException if failure in evaluation
*/
String evaluate(AttributeValueDecorator decorator) throws ProcessException;
@@ -47,9 +45,9 @@ public interface AttributeExpression {
* id, etc. of the given FlowFile, as well as System Properties and JVM
* Environment properties
*
- * @param flowFile
- * @return
- * @throws ProcessException
+ * @param flowFile to evaluate
+ * @return evaluated value
+ * @throws ProcessException if failure evaluating
*/
String evaluate(FlowFile flowFile) throws ProcessException;
@@ -58,17 +56,15 @@ public interface AttributeExpression {
* id, etc. of the given FlowFile, as well as System Properties and JVM
* Environment properties and allows the values to be decorated
*
- * @param flowFile
- * @param decorator
- * @return
- * @throws ProcessException
+ * @param flowFile to evaluate
+ * @param decorator for evaluation
+ * @return evaluated value
+ * @throws ProcessException if failed to evaluate
*/
String evaluate(FlowFile flowFile, AttributeValueDecorator decorator) throws ProcessException;
/**
- * Returns the type that is returned by the Expression
- *
- * @return
+ * @return the type that is returned by the Expression
*/
ResultType getResultType();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeValueDecorator.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeValueDecorator.java b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeValueDecorator.java
index af071f3..4cea248 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeValueDecorator.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/AttributeValueDecorator.java
@@ -22,8 +22,8 @@ public interface AttributeValueDecorator {
* Decorates the value of a FlowFile Attribute or System/JVM property in
* some way
*
- * @param attributeValue
- * @return
+ * @param attributeValue to decorate
+ * @return decorated value
*/
String decorate(String attributeValue);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/expression/ExpressionLanguageCompiler.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/ExpressionLanguageCompiler.java b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/ExpressionLanguageCompiler.java
index aced2e6..9383d27 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/expression/ExpressionLanguageCompiler.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/expression/ExpressionLanguageCompiler.java
@@ -25,7 +25,7 @@ public interface ExpressionLanguageCompiler {
* AttributeExpression that can be evaluated
*
* @param expression the Attribute Expression to be compiled
- * @return
+ * @return expression that can be evaluated
* @throws IllegalArgumentException if the given expression is not valid
*/
AttributeExpression compile(String expression) throws IllegalArgumentException;
@@ -34,8 +34,8 @@ public interface ExpressionLanguageCompiler {
* Indicates whether or not the given string is a valid Attribute
* Expression.
*
- * @param expression
- * @return
+ * @param expression to validate
+ * @return if is value or not
*/
boolean isValidExpression(String expression);
@@ -44,7 +44,7 @@ public interface ExpressionLanguageCompiler {
* if the expression is syntactically valid or a String indicating why the
* expression is invalid otherwise.
*
- * @param expression
+ * @param expression to validate
* @param allowSurroundingCharacters if <code>true</code> allows characters
* to surround the Expression, otherwise the expression must be exactly
* equal to a valid Expression. E.g., <code>/${path}</code> is valid if and
@@ -60,7 +60,7 @@ public interface ExpressionLanguageCompiler {
* Returns the ResultType that will be returned by the given Expression
*
* @param expression the Expression to evaluate
- * @return
+ * @return result type for the given expression
* @throws IllegalArgumentException if the given Expression is not a valid
* Expression Language Expression; the message of this Exception will
* indicate the problem if the expression is not syntactically valid.
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bcb3ca8f/nifi/nifi-api/src/main/java/org/apache/nifi/flowfile/FlowFile.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/flowfile/FlowFile.java b/nifi/nifi-api/src/main/java/org/apache/nifi/flowfile/FlowFile.java
index bce92ee..0e2c19d 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/flowfile/FlowFile.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/flowfile/FlowFile.java
@@ -48,24 +48,22 @@ public interface FlowFile extends Comparable<FlowFile> {
long getLineageStartDate();
/**
- * Returns the time at which the FlowFile was most recently added to a
+ * @return the time at which the FlowFile was most recently added to a
* FlowFile queue, or {@code null} if the FlowFile has never been enqueued.
* This value will always be populated before it is passed to a
- * {@link FlowFilePrioritizer}.
- *
- * @return
+ * {@link FlowFilePrioritizer}
*/
Long getLastQueueDate();
/**
- * @return a set of identifiers that are unique to this FlowFile's lineage.
- * If FlowFile X is derived from FlowFile Y, both FlowFiles will have the
- * same value for the Lineage Claim ID.
- *
* <p>
* If a FlowFile is derived from multiple "parent" FlowFiles, all of the
* parents' Lineage Identifiers will be in the set.
* </p>
+ *
+ * @return a set of identifiers that are unique to this FlowFile's lineage.
+ * If FlowFile X is derived from FlowFile Y, both FlowFiles will have the
+ * same value for the Lineage Claim ID.
*/
Set<String> getLineageIdentifiers();
@@ -77,7 +75,7 @@ public interface FlowFile extends Comparable<FlowFile> {
/**
* Obtains the attribute value for the given key
*
- * @param key
+ * @param key of the attribute
* @return value if found; null otherwise
*/
String getAttribute(String key);