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:01 UTC
[11/49] incubator-nifi git commit: NIFI-271 checkpoint push because
there are so many changes. Long way to go but got through dto library
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/ObjectHolder.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/ObjectHolder.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/ObjectHolder.java
index a58ec6a..12a887c 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/ObjectHolder.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/ObjectHolder.java
@@ -19,7 +19,6 @@ package org.apache.nifi.util;
/**
* A bean that holds a single value of type T.
*
- * @param <T>
*/
public class ObjectHolder<T> {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java
index 81f32ab..b46bae5 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java
@@ -26,7 +26,6 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
/**
* Thread-safe implementation of a RingBuffer
*
- * @param <T>
*/
public class RingBuffer<T> {
@@ -46,8 +45,8 @@ public class RingBuffer<T> {
* Adds the given value to the RingBuffer and returns the value that was
* removed in order to make room.
*
- * @param value
- * @return
+ * @param value the new value to add
+ * @return value previously in the buffer
*/
@SuppressWarnings("unchecked")
public T add(final T value) {
@@ -135,8 +134,8 @@ public class RingBuffer<T> {
/**
* Removes all elements from the RingBuffer that match the given filter
*
- * @param filter
- * @return
+ * @param filter to use for deciding what is removed
+ * @return always zero
*/
public int removeSelectedElements(final Filter<T> filter) {
int count = 0;
@@ -209,7 +208,7 @@ public class RingBuffer<T> {
* will skip all remaining elements in the RingBuffer; otherwise, the next
* element will be evaluated until all elements have been evaluated.
*
- * @param evaluator
+ * @param evaluator used to evaluate each item in the ring buffer
*/
public void forEach(final ForEachEvaluator<T> evaluator) {
forEach(evaluator, IterationDirection.FORWARD);
@@ -222,7 +221,7 @@ public class RingBuffer<T> {
* will skip all remaining elements in the RingBuffer; otherwise, the next
* element will be evaluated until all elements have been evaluated.
*
- * @param evaluator
+ * @param evaluator the evaluator
* @param iterationDirection the order in which to iterate over the elements
* in the RingBuffer
*/
@@ -270,7 +269,7 @@ public class RingBuffer<T> {
* Defines an interface that can be used to iterate over all of the elements
* in the RingBuffer via the {@link #forEach} method
*
- * @param <S>
+ * @param <S> the type to evaluate
*/
public static interface ForEachEvaluator<S> {
@@ -278,8 +277,8 @@ public class RingBuffer<T> {
* Evaluates the given element and returns {@code true} if the next
* element should be evaluated, {@code false} otherwise
*
- * @param value
- * @return
+ * @param value the value to evaluate
+ * @return true if should continue evaluating; false otherwise
*/
boolean evaluate(S value);
}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java
index cd11930..bc8ab75 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java
@@ -55,8 +55,8 @@ public final class StopWatch {
/**
* Returns the amount of time that the StopWatch was running.
*
- * @param timeUnit
- * @return
+ * @param timeUnit the unit for which the duration should be reported
+ * @return the duration of the stopwatch in the specified unit
*
* @throws IllegalStateException if the StopWatch has not been stopped via
* {@link #stop()}
@@ -71,8 +71,8 @@ public final class StopWatch {
/**
* Returns the amount of time that has elapsed since the timer was started.
*
- * @param timeUnit
- * @return
+ * @param timeUnit the unit for which the elapsed time should be computed
+ * @return the elapsed time in the specified unit
*/
public long getElapsed(final TimeUnit timeUnit) {
return timeUnit.convert(System.nanoTime() - startNanos, TimeUnit.NANOSECONDS);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/Tuple.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/Tuple.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/Tuple.java
index 63736ed..c797c7f 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/Tuple.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/Tuple.java
@@ -16,12 +16,6 @@
*/
package org.apache.nifi.util;
-/**
- *
- * @author unattrib
- * @param <A>
- * @param <B>
- */
public class Tuple<A, B> {
final A key;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugDisabledTimedLock.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugDisabledTimedLock.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugDisabledTimedLock.java
index a8d7e82..8faf3ba 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugDisabledTimedLock.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugDisabledTimedLock.java
@@ -29,7 +29,7 @@ public class DebugDisabledTimedLock implements DebuggableTimedLock {
/**
*
- * @return
+ * @return true if lock obtained; false otherwise
*/
@Override
public boolean tryLock() {
@@ -38,9 +38,9 @@ public class DebugDisabledTimedLock implements DebuggableTimedLock {
/**
*
- * @param timeout
- * @param timeUnit
- * @return
+ * @param timeout the duration of time to wait for the lock
+ * @param timeUnit the unit which provides meaning to the duration
+ * @return true if obtained lock in time; false otherwise
*/
@Override
public boolean tryLock(final long timeout, final TimeUnit timeUnit) {
@@ -51,9 +51,6 @@ public class DebugDisabledTimedLock implements DebuggableTimedLock {
}
}
- /**
- *
- */
@Override
public void lock() {
lock.lock();
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugEnabledTimedLock.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugEnabledTimedLock.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugEnabledTimedLock.java
index f082168..e7d599e 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugEnabledTimedLock.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/concurrency/DebugEnabledTimedLock.java
@@ -44,8 +44,7 @@ public class DebugEnabledTimedLock implements DebuggableTimedLock {
}
/**
- *
- * @return
+ * @return true if lock obtained; false otherwise
*/
@Override
public boolean tryLock() {
@@ -61,10 +60,9 @@ public class DebugEnabledTimedLock implements DebuggableTimedLock {
}
/**
- *
- * @param timeout
- * @param timeUnit
- * @return
+ * @param timeout duration to wait for lock
+ * @param timeUnit unit to understand given duration
+ * @return true if lock obtained in time; false otherwise
*/
@Override
public boolean tryLock(final long timeout, final TimeUnit timeUnit) {
@@ -84,9 +82,6 @@ public class DebugEnabledTimedLock implements DebuggableTimedLock {
return true;
}
- /**
- *
- */
@Override
public void lock() {
logger.trace("Obtaining Lock {}", name);
@@ -96,8 +91,7 @@ public class DebugEnabledTimedLock implements DebuggableTimedLock {
}
/**
- *
- * @param task
+ * @param task to release the lock for
*/
@Override
public void unlock(final String task) {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java
index 41a0557..73c8aa0 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java
@@ -16,7 +16,6 @@
*/
package org.apache.nifi.util.file;
-import java.io.BufferedInputStream;
import java.io.Closeable;
import java.io.File;
import java.io.FileInputStream;
@@ -53,7 +52,7 @@ public class FileUtils {
/**
* Closes the given closeable quietly - no logging, no exceptions...
*
- * @param closeable
+ * @param closeable the thing to close
*/
public static void closeQuietly(final Closeable closeable) {
if (null != closeable) {
@@ -66,9 +65,9 @@ public class FileUtils {
}
/**
- * Releases the given lock quietly - no logging, no exception
+ * Releases the given lock quietly no logging, no exception
*
- * @param lock
+ * @param lock the lock to release
*/
public static void releaseQuietly(final FileLock lock) {
if (null != lock) {
@@ -98,9 +97,10 @@ public class FileUtils {
* Deletes the given file. If the given file exists but could not be deleted
* this will be printed as a warning to the given logger
*
- * @param file
- * @param logger
- * @return
+ * @param file the file to delete
+ * @param logger the logger to provide logging information to about the
+ * operation
+ * @return true if given file no longer exists
*/
public static boolean deleteFile(final File file, final Logger logger) {
return FileUtils.deleteFile(file, logger, 1);
@@ -110,8 +110,8 @@ public class FileUtils {
* Deletes the given file. If the given file exists but could not be deleted
* this will be printed as a warning to the given logger
*
- * @param file
- * @param logger
+ * @param file the file to delete
+ * @param logger the logger to write to
* @param attempts indicates how many times an attempt to delete should be
* made
* @return true if given file no longer exists
@@ -192,9 +192,9 @@ public class FileUtils {
* recursive) that match the given filename filter. If any file cannot be
* deleted then this is printed at warn to the given logger.
*
- * @param directory
+ * @param directory the directory to scan for files to delete
* @param filter if null then no filter is used
- * @param logger
+ * @param logger the logger to use
*/
public static void deleteFilesInDir(final File directory, final FilenameFilter filter, final Logger logger) {
FileUtils.deleteFilesInDir(directory, filter, logger, false);
@@ -205,10 +205,10 @@ public class FileUtils {
* that match the given filename filter. If any file cannot be deleted then
* this is printed at warn to the given logger.
*
- * @param directory
+ * @param directory the directory to scan
* @param filter if null then no filter is used
- * @param logger
- * @param recurse
+ * @param logger the logger to use
+ * @param recurse indicates whether to recurse subdirectories
*/
public static void deleteFilesInDir(final File directory, final FilenameFilter filter, final Logger logger, final boolean recurse) {
FileUtils.deleteFilesInDir(directory, filter, logger, recurse, false);
@@ -219,10 +219,10 @@ public class FileUtils {
* that match the given filename filter. If any file cannot be deleted then
* this is printed at warn to the given logger.
*
- * @param directory
+ * @param directory the directory to scan
* @param filter if null then no filter is used
- * @param logger
- * @param recurse
+ * @param logger the logger
+ * @param recurse whether to recurse subdirectories or not
* @param deleteEmptyDirectories default is false; if true will delete
* directories found that are empty
*/
@@ -248,9 +248,9 @@ public class FileUtils {
/**
* Deletes given files.
*
- * @param files
- * @param recurse will recurse
- * @throws IOException
+ * @param files the files to delete
+ * @param recurse will recurse if true; false otherwise
+ * @throws IOException if any issues deleting specified files
*/
public static void deleteFiles(final Collection<File> files, final boolean recurse) throws IOException {
for (final File file : files) {
@@ -352,8 +352,8 @@ public class FileUtils {
* Copies the given source file to the given destination file. The given
* destination will be overwritten if it already exists.
*
- * @param source
- * @param destination
+ * @param source the file to copy
+ * @param destination the file to copy to
* @param lockInputFile if true will lock input file during copy; if false
* will not
* @param lockOutputFile if true will lock output file during copy; if false
@@ -369,11 +369,12 @@ public class FileUtils {
* indicating the problem.
* @return long number of bytes copied
* @throws FileNotFoundException if the source file could not be found
- * @throws IOException
+ * @throws IOException if unable to read or write the underlying streams
* @throws SecurityException if a security manager denies the needed file
* operations
*/
- public static long copyFile(final File source, final File destination, final boolean lockInputFile, final boolean lockOutputFile, final boolean move, final Logger logger) throws FileNotFoundException, IOException {
+ public static long copyFile(final File source, final File destination, final boolean lockInputFile, final boolean lockOutputFile, final boolean move, final Logger logger)
+ throws FileNotFoundException, IOException {
FileInputStream fis = null;
FileOutputStream fos = null;
@@ -436,16 +437,16 @@ public class FileUtils {
* Copies the given source file to the given destination file. The given
* destination will be overwritten if it already exists.
*
- * @param source
- * @param destination
+ * @param source the file to copy from
+ * @param destination the file to copy to
* @param lockInputFile if true will lock input file during copy; if false
* will not
* @param lockOutputFile if true will lock output file during copy; if false
* will not
- * @param logger
+ * @param logger the logger to use
* @return long number of bytes copied
* @throws FileNotFoundException if the source file could not be found
- * @throws IOException
+ * @throws IOException if unable to read or write to file
* @throws SecurityException if a security manager denies the needed file
* operations
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java
index e0089c1..270d4d7 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java
@@ -61,8 +61,8 @@ public class SynchronousFileWatcher {
* Checks if the file has been updated according to the configured
* {@link UpdateMonitor} and resets the state
*
- * @return
- * @throws IOException
+ * @return true if updated; false otherwise
+ * @throws IOException if failure occurs checking for changes
*/
public boolean checkAndReset() throws IOException {
if (checkUpdateMillis <= 0) { // if checkUpdateMillis <= 0, always check
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java
index 59b444a..f93902f 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java
@@ -26,8 +26,6 @@ import org.apache.nifi.util.search.ahocorasick.SearchState;
* Defines an interface to search for content given a set of search terms. Any
* implementation of search must be thread safe.
*
- * @author
- * @param <T>
*/
public interface Search<T> {
@@ -35,7 +33,7 @@ public interface Search<T> {
* Establishes the dictionary of terms which will be searched in subsequent
* search calls. This can be called only once
*
- * @param terms
+ * @param terms the terms to create a dictionary of
*/
void initializeDictionary(Set<SearchTerm<T>> terms);
@@ -43,7 +41,7 @@ public interface Search<T> {
* Searches the given input stream for matches between the already specified
* dictionary and the contents scanned.
*
- * @param haystack
+ * @param haystack the source data to scan for hits
* @param findAll if true will find all matches if false will find only the
* first match
* @return SearchState containing results Map might be empty which indicates
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java
index 62de964..a1d361e 100644
--- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java
+++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java
@@ -22,8 +22,6 @@ import java.util.Arrays;
/**
* This is an immutable thread safe object representing a search term
*
- * @author
- * @param <T>
*/
public class SearchTerm<T> {
@@ -34,8 +32,8 @@ public class SearchTerm<T> {
/**
* Constructs a SearchTerm. Defensively copies the given byte array
*
- * @param bytes
- * @throws IllegalArgument exception if given bytes are null or 0 length
+ * @param bytes the bytes of the search term
+ * @throws IllegalArgumentException if given bytes are null or 0 length
*/
public SearchTerm(final byte[] bytes) {
this(bytes, true, null);
@@ -46,9 +44,9 @@ public class SearchTerm<T> {
* given byte array. If the caller indicates a defensive copy is not
* necessary then they must not change the given arrays state any longer
*
- * @param bytes
- * @param defensiveCopy
- * @param reference
+ * @param bytes the bytes of the new search term
+ * @param defensiveCopy if true will make a defensive copy; false otherwise
+ * @param reference a holder for an object which can be retrieved when this search term hits
*/
public SearchTerm(final byte[] bytes, final boolean defensiveCopy, final T reference) {
if (bytes == null || bytes.length == 0) {
@@ -84,7 +82,7 @@ public class SearchTerm<T> {
/**
* Determines if the given window starts with the same bytes as this term
*
- * @param window Current window of bytes from the haystack being evaluated.
+ * @param window bytes from the haystack being evaluated
* @param windowLength The length of the window to consider
* @return true if this term starts with the same bytes of the given window
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestCompoundUpdateMonitor.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestCompoundUpdateMonitor.java b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestCompoundUpdateMonitor.java
index f576e94..ec04efb 100644
--- a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestCompoundUpdateMonitor.java
+++ b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestCompoundUpdateMonitor.java
@@ -27,7 +27,6 @@ import java.io.OutputStream;
import java.nio.file.Path;
import java.util.UUID;
-
import org.junit.Test;
public class TestCompoundUpdateMonitor {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestSynchronousFileWatcher.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestSynchronousFileWatcher.java b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestSynchronousFileWatcher.java
index 7125581..3440c16 100644
--- a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestSynchronousFileWatcher.java
+++ b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/file/monitor/TestSynchronousFileWatcher.java
@@ -30,7 +30,6 @@ import java.nio.file.StandardCopyOption;
import org.junit.Test;
-
public class TestSynchronousFileWatcher {
@Test
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/timebuffer/TestRingBuffer.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/timebuffer/TestRingBuffer.java b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/timebuffer/TestRingBuffer.java
index 5f8c4c8..b01b495 100644
--- a/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/timebuffer/TestRingBuffer.java
+++ b/nifi/nifi-commons/nifi-utils/src/test/java/org/apache/nifi/util/timebuffer/TestRingBuffer.java
@@ -36,13 +36,13 @@ public class TestRingBuffer {
@Test
public void testGetNewestElement() {
final RingBuffer<Integer> ringBuffer = new RingBuffer<>(10);
-
- for (int i=0; i < 11; i++) {
+
+ for (int i = 0; i < 11; i++) {
ringBuffer.add(i);
assertEquals(i, ringBuffer.getNewestElement().intValue());
}
}
-
+
@Test
public void testAsList() {
final RingBuffer<Integer> ringBuffer = new RingBuffer<>(10);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-commons/nifi-web-utils/src/main/java/org/apache/nifi/web/util/ClientUtils.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-commons/nifi-web-utils/src/main/java/org/apache/nifi/web/util/ClientUtils.java b/nifi/nifi-commons/nifi-web-utils/src/main/java/org/apache/nifi/web/util/ClientUtils.java
index 8c0b1f4..1eaf366 100644
--- a/nifi/nifi-commons/nifi-web-utils/src/main/java/org/apache/nifi/web/util/ClientUtils.java
+++ b/nifi/nifi-commons/nifi-web-utils/src/main/java/org/apache/nifi/web/util/ClientUtils.java
@@ -40,10 +40,10 @@ public class ClientUtils {
/**
* Gets the content at the specified URI.
*
- * @param uri
- * @return
- * @throws ClientHandlerException
- * @throws UniformInterfaceException
+ * @param uri the URI to get the content of
+ * @return the client response resulting from getting the content of the URI
+ * @throws ClientHandlerException if issues occur handling the request
+ * @throws UniformInterfaceException if any interface violations occur
*/
public ClientResponse get(final URI uri) throws ClientHandlerException, UniformInterfaceException {
return get(uri, null);
@@ -52,11 +52,11 @@ public class ClientUtils {
/**
* Gets the content at the specified URI using the given query parameters.
*
- * @param uri
- * @param queryParams
- * @return
- * @throws ClientHandlerException
- * @throws UniformInterfaceException
+ * @param uri the URI to get the content of
+ * @param queryParams the query parameters to use in the request
+ * @return the client response resulting from getting the content of the URI
+ * @throws ClientHandlerException if issues occur handling the request
+ * @throws UniformInterfaceException if any interface violations occur
*/
public ClientResponse get(final URI uri, final Map<String, String> queryParams) throws ClientHandlerException, UniformInterfaceException {
// perform the request
@@ -73,9 +73,9 @@ public class ClientUtils {
/**
* Performs a POST using the specified url and entity body.
*
- * @param uri
- * @param entity
- * @return
+ * @param uri the URI to post to
+ * @param entity the item to post
+ * @return the client response of the request
*/
public ClientResponse post(URI uri, Object entity) throws ClientHandlerException, UniformInterfaceException {
// get the resource
@@ -93,9 +93,9 @@ public class ClientUtils {
/**
* Performs a POST using the specified url and form data.
*
- * @param uri
- * @param formData
- * @return
+ * @param uri the uri to post to
+ * @param formData the data to post
+ * @return the client reponse of the post
*/
public ClientResponse post(URI uri, Map<String, String> formData) throws ClientHandlerException, UniformInterfaceException {
// convert the form data
@@ -119,10 +119,10 @@ public class ClientUtils {
/**
* Performs a HEAD request to the specified URI.
*
- * @param uri
- * @return
- * @throws ClientHandlerException
- * @throws UniformInterfaceException
+ * @param uri the uri to request the head of
+ * @return the client response of the request
+ * @throws ClientHandlerException for issues handling the request
+ * @throws UniformInterfaceException for issues with the request
*/
public ClientResponse head(final URI uri) throws ClientHandlerException, UniformInterfaceException {
// perform the request
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-docs/pom.xml
----------------------------------------------------------------------
diff --git a/nifi/nifi-docs/pom.xml b/nifi/nifi-docs/pom.xml
index 7f2b022..f724e96 100644
--- a/nifi/nifi-docs/pom.xml
+++ b/nifi/nifi-docs/pom.xml
@@ -104,6 +104,15 @@
</configuration>
</plugin>
<plugin>
+ <groupId>org.apache.rat</groupId>
+ <artifactId>apache-rat-plugin</artifactId>
+ <configuration>
+ <excludes>
+ <exclude>src/main/asciidoc/asciidoc-mod.css</exclude> <!-- MIT license confirmed. Excluding due to parse error-->
+ </excludes>
+ </configuration>
+ </plugin>
+ <plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<attach>true</attach>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java
index ddc3d2e..a71484e 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java
@@ -34,9 +34,7 @@ public class BulletinBoardDTO {
private Date generated;
/**
- * The bulletins to populate in the bulletin board.
- *
- * @return
+ * @return bulletins to populate in the bulletin board
*/
public List<BulletinDTO> getBulletins() {
return bulletins;
@@ -47,9 +45,7 @@ public class BulletinBoardDTO {
}
/**
- * When this bulletin board was generated.
- *
- * @return
+ * @return when this bulletin board was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
public Date getGenerated() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java
index c6aca24..239e710 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java
@@ -40,9 +40,7 @@ public class BulletinDTO {
private Date timestamp;
/**
- * The id of this message.
- *
- * @return
+ * @return id of this message
*/
public Long getId() {
return id;
@@ -53,10 +51,8 @@ public class BulletinDTO {
}
/**
- * When clustered, the address of the node from which this bulletin
- * originated.
- *
- * @return
+ * @return When clustered, the address of the node from which this bulletin
+ * originated
*/
public String getNodeAddress() {
return nodeAddress;
@@ -67,9 +63,7 @@ public class BulletinDTO {
}
/**
- * The group id of the source component.
- *
- * @return
+ * @return group id of the source component
*/
public String getGroupId() {
return groupId;
@@ -80,9 +74,7 @@ public class BulletinDTO {
}
/**
- * The category of this message.
- *
- * @return
+ * @return category of this message
*/
public String getCategory() {
return category;
@@ -93,9 +85,7 @@ public class BulletinDTO {
}
/**
- * The actual message.
- *
- * @return
+ * @return actual message
*/
public String getMessage() {
return message;
@@ -106,9 +96,7 @@ public class BulletinDTO {
}
/**
- * The id of the source of this message.
- *
- * @return
+ * @return id of the source of this message
*/
public String getSourceId() {
return sourceId;
@@ -119,9 +107,7 @@ public class BulletinDTO {
}
/**
- * The name of the source of this message.
- *
- * @return
+ * @return name of the source of this message
*/
public String getSourceName() {
return sourceName;
@@ -132,9 +118,7 @@ public class BulletinDTO {
}
/**
- * The level of this bulletin.
- *
- * @return
+ * @return level of this bulletin
*/
public String getLevel() {
return level;
@@ -145,9 +129,7 @@ public class BulletinDTO {
}
/**
- * When this bulletin was generated as a formatted string.
- *
- * @return
+ * @return When this bulletin was generated as a formatted string
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
public Date getTimestamp() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java
index 015b174..cf4146d 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java
@@ -33,9 +33,7 @@ public class BulletinQueryDTO {
private Integer limit;
/**
- * Include bulletins after this id.
- *
- * @return
+ * @return Include bulletins after this id
*/
public Long getAfter() {
return after;
@@ -46,9 +44,7 @@ public class BulletinQueryDTO {
}
/**
- * Include bulletin within this group. Supports a regular expression.
- *
- * @return
+ * @return Include bulletin within this group. Supports a regular expression
*/
public String getGroupId() {
return groupId;
@@ -59,9 +55,7 @@ public class BulletinQueryDTO {
}
/**
- * Include bulletins that match this message. Supports a regular expression.
- *
- * @return
+ * @return Include bulletins that match this message. Supports a regular expression
*/
public String getMessage() {
return message;
@@ -72,9 +66,7 @@ public class BulletinQueryDTO {
}
/**
- * Include bulletins that match this name. Supports a regular expression.
- *
- * @return
+ * @return Include bulletins that match this name. Supports a regular expression
*/
public String getName() {
return name;
@@ -85,9 +77,7 @@ public class BulletinQueryDTO {
}
/**
- * Include bulletins that match this id. Supports a source id.
- *
- * @return
+ * @return Include bulletins that match this id. Supports a source id
*/
public String getSourceId() {
return sourceId;
@@ -98,9 +88,7 @@ public class BulletinQueryDTO {
}
/**
- * The maximum number of bulletins to return.
- *
- * @return
+ * @return The maximum number of bulletins to return
*/
public Integer getLimit() {
return limit;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java
index 53100e3..161e788 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java
@@ -33,9 +33,7 @@ public class ClusterDTO {
private Date generated;
/**
- * The collection of the node DTOs.
- *
- * @return
+ * @return collection of the node DTOs
*/
public Collection<NodeDTO> getNodes() {
return nodes;
@@ -46,9 +44,7 @@ public class ClusterDTO {
}
/**
- * Gets the date/time that this report was generated.
- *
- * @return
+ * @return the date/time that this report was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
public Date getGenerated() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java
index 3bdbe28..2345b08 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java
@@ -29,9 +29,7 @@ public class ComponentHistoryDTO {
private Map<String, PropertyHistoryDTO> propertyHistory;
/**
- * The component id.
- *
- * @return
+ * @return component id
*/
public String getComponentId() {
return componentId;
@@ -42,9 +40,7 @@ public class ComponentHistoryDTO {
}
/**
- * The history for this components properties.
- *
- * @return
+ * @return history for this components properties
*/
public Map<String, PropertyHistoryDTO> getPropertyHistory() {
return propertyHistory;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java
index 1be480c..199c73e 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java
@@ -34,9 +34,7 @@ public class ConnectableDTO {
private String comments;
/**
- * The id of this connectable component.
- *
- * @return
+ * @return id of this connectable component
*/
public String getId() {
return id;
@@ -47,9 +45,7 @@ public class ConnectableDTO {
}
/**
- * The type of this connectable component.
- *
- * @return
+ * @return type of this connectable component
*/
public String getType() {
return type;
@@ -60,9 +56,7 @@ public class ConnectableDTO {
}
/**
- * The id of the group that this connectable component resides in.
- *
- * @return
+ * @return id of the group that this connectable component resides in
*/
public String getGroupId() {
return groupId;
@@ -73,9 +67,7 @@ public class ConnectableDTO {
}
/**
- * The name of this connectable component.
- *
- * @return
+ * @return name of this connectable component
*/
public String getName() {
return name;
@@ -86,9 +78,7 @@ public class ConnectableDTO {
}
/**
- * Used to reflect the current state of this Connectable.
- *
- * @return
+ * @return Used to reflect the current state of this Connectable
*/
public Boolean isRunning() {
return running;
@@ -99,10 +89,8 @@ public class ConnectableDTO {
}
/**
- * If this represents a remote port it is used to indicate whether the
- * target exists.
- *
- * @return
+ * @return If this represents a remote port it is used to indicate whether the
+ * target exists
*/
public Boolean getExists() {
return exists;
@@ -113,10 +101,8 @@ public class ConnectableDTO {
}
/**
- * If this represents a remote port it is used to indicate whether is it
- * configured to transmit.
- *
- * @return
+ * @return If this represents a remote port it is used to indicate whether is it
+ * configured to transmit
*/
public Boolean getTransmitting() {
return transmitting;
@@ -127,9 +113,7 @@ public class ConnectableDTO {
}
/**
- * The comments from this Connectable.
- *
- * @return
+ * @return The comments from this Connectable
*/
public String getComments() {
return comments;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
index 660820c..1bd382e 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
@@ -67,9 +67,7 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
- * The name of the connection.
- *
- * @return
+ * @return name of the connection
*/
public String getName() {
return name;
@@ -80,9 +78,7 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
- * The position of the bend points on this connection.
- *
- * @return
+ * @return position of the bend points on this connection
*/
public List<PositionDTO> getBends() {
return bends;
@@ -93,10 +89,8 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
- * The index of control point that the connection label should be placed
- * over.
- *
- * @return
+ * @return The index of control point that the connection label should be placed
+ * over
*/
public Integer getLabelIndex() {
return labelIndex;
@@ -107,9 +101,7 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
- * The z index for this connection.
- *
- * @return
+ * @return z index for this connection
*/
public Long getzIndex() {
return zIndex;
@@ -133,10 +125,8 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
- * The relationships that the source of the connection currently supports.
- * This property is read only.
- *
- * @return
+ * @return relationships that the source of the connection currently supports.
+ * This property is read only
*/
public Set<String> getAvailableRelationships() {
return availableRelationships;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java
index 190cb47..8e09fe7 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java
@@ -42,9 +42,7 @@ public class ControllerConfigurationDTO {
private String uri;
/**
- * The maximum number of timer driven threads this NiFi has available.
- *
- * @return The maximum number of threads
+ * @return maximum number of timer driven threads this NiFi has available
*/
public Integer getMaxTimerDrivenThreadCount() {
return maxTimerDrivenThreadCount;
@@ -55,9 +53,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The maximum number of event driven thread this NiFi has available.
- *
- * @return
+ * @return maximum number of event driven thread this NiFi has available
*/
public Integer getMaxEventDrivenThreadCount() {
return maxEventDrivenThreadCount;
@@ -68,9 +64,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The name of this NiFi.
- *
- * @return The name
+ * @return name of this NiFi
*/
public String getName() {
return name;
@@ -81,9 +75,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The comments for this NiFi.
- *
- * @return
+ * @return comments for this NiFi
*/
public String getComments() {
return comments;
@@ -94,10 +86,8 @@ public class ControllerConfigurationDTO {
}
/**
- * The interval in seconds between the automatic NiFi refresh requests. This
- * value is read only.
- *
- * @return The interval in seconds
+ * @return interval in seconds between the automatic NiFi refresh requests. This
+ * value is read only
*/
public Long getAutoRefreshIntervalSeconds() {
return autoRefreshIntervalSeconds;
@@ -108,10 +98,8 @@ public class ControllerConfigurationDTO {
}
/**
- * Indicates whether or not Site-to-Site communications with this instance
- * is secure (2-way authentication). This value is read only.
- *
- * @return
+ * @return Indicates whether or not Site-to-Site communications with this instance
+ * is secure (2-way authentication). This value is read only
*/
public Boolean isSiteToSiteSecure() {
return siteToSiteSecure;
@@ -122,9 +110,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The current time on the server.
- *
- * @return
+ * @return current time on the server
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
public Date getCurrentTime() {
@@ -136,9 +122,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The time offset of the server.
- *
- * @return
+ * @return time offset of the server
*/
public Integer getTimeOffset() {
return timeOffset;
@@ -149,9 +133,7 @@ public class ControllerConfigurationDTO {
}
/**
- * Returns the URL for the content viewer if configured.
- *
- * @return
+ * @return the URL for the content viewer if configured
*/
public String getContentViewerUrl() {
return contentViewerUrl;
@@ -162,9 +144,7 @@ public class ControllerConfigurationDTO {
}
/**
- * The URI for this NiFi controller.
- *
- * @return
+ * @return URI for this NiFi controller
*/
public String getUri() {
return uri;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java
index 9e15fc1..c5ee057 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java
@@ -48,9 +48,7 @@ public class ControllerDTO {
private Set<PortDTO> outputPorts;
/**
- * The id of this NiFi controller.
- *
- * @return
+ * @return id of this NiFi controller
*/
public String getId() {
return id;
@@ -74,9 +72,7 @@ public class ControllerDTO {
}
/**
- * The comments of this NiFi controller.
- *
- * @return
+ * @return comments of this NiFi controller
*/
public String getComments() {
return comments;
@@ -87,9 +83,7 @@ public class ControllerDTO {
}
/**
- * The input ports available to send data to this NiFi controller.
- *
- * @return
+ * @return input ports available to send data to this NiFi controller
*/
public Set<PortDTO> getInputPorts() {
return inputPorts;
@@ -100,9 +94,7 @@ public class ControllerDTO {
}
/**
- * The output ports available to received data from this NiFi controller.
- *
- * @return
+ * @return output ports available to received data from this NiFi controller
*/
public Set<PortDTO> getOutputPorts() {
return outputPorts;
@@ -113,10 +105,8 @@ public class ControllerDTO {
}
/**
- * The Instance ID of the cluster, if this node is connected to a Cluster
+ * @return Instance ID of the cluster, if this node is connected to a Cluster
* Manager, or of this individual instance of in standalone mode
- *
- * @return
*/
public String getInstanceId() {
return instanceId;
@@ -143,10 +133,8 @@ public class ControllerDTO {
}
/**
- * Indicates whether or not Site-to-Site communications with this instance
+ * @return Indicates whether or not Site-to-Site communications with this instance
* is secure (2-way authentication)
- *
- * @return
*/
public Boolean isSiteToSiteSecure() {
return siteToSiteSecure;
@@ -157,9 +145,7 @@ public class ControllerDTO {
}
/**
- * The number of running components in this process group.
- *
- * @return
+ * @return number of running components in this process group
*/
public Integer getRunningCount() {
return runningCount;
@@ -170,9 +156,7 @@ public class ControllerDTO {
}
/**
- * The number of stopped components in this process group.
- *
- * @return
+ * @return number of stopped components in this process group
*/
public Integer getStoppedCount() {
return stoppedCount;
@@ -183,9 +167,7 @@ public class ControllerDTO {
}
/**
- * The number of active remote ports contained in this process group.
- *
- * @return
+ * @return number of active remote ports contained in this process group
*/
public Integer getActiveRemotePortCount() {
return activeRemotePortCount;
@@ -196,9 +178,7 @@ public class ControllerDTO {
}
/**
- * The number of inactive remote ports contained in this process group.
- *
- * @return
+ * @return number of inactive remote ports contained in this process group
*/
public Integer getInactiveRemotePortCount() {
return inactiveRemotePortCount;
@@ -209,9 +189,7 @@ public class ControllerDTO {
}
/**
- * The number of input ports contained in this process group.
- *
- * @return
+ * @return number of input ports contained in this process group
*/
public Integer getInputPortCount() {
return inputPortCount;
@@ -222,9 +200,7 @@ public class ControllerDTO {
}
/**
- * The number of invalid components in this process group.
- *
- * @return
+ * @return number of invalid components in this process group
*/
public Integer getInvalidCount() {
return invalidCount;
@@ -235,9 +211,7 @@ public class ControllerDTO {
}
/**
- * The number of disabled components in this process group.
- *
- * @return
+ * @return number of disabled components in this process group
*/
public Integer getDisabledCount() {
return disabledCount;
@@ -248,9 +222,7 @@ public class ControllerDTO {
}
/**
- * The number of output ports in this process group.
- *
- * @return
+ * @return number of output ports in this process group
*/
public Integer getOutputPortCount() {
return outputPortCount;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
index 75d18a2..02ba2e2 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
@@ -32,21 +32,19 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
private String comments;
private String availability;
private String state;
-
+
private Map<String, String> properties;
private Map<String, PropertyDescriptorDTO> descriptors;
-
+
private String customUiUrl;
private String annotationData;
-
+
private Set<ControllerServiceReferencingComponentDTO> referencingComponents;
-
+
private Collection<String> validationErrors;
/**
- * The controller service name.
- *
- * @return
+ * @return controller service name
*/
public String getName() {
return name;
@@ -57,9 +55,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * The controller service type.
- *
- * @return
+ * @return the controller service type
*/
public String getType() {
return type;
@@ -68,24 +64,20 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
public void setType(String type) {
this.type = type;
}
-
/**
- * The comment for the Controller Service
- * @return
+ * @return the comment for the Controller Service
*/
public String getComments() {
- return comments;
- }
+ return comments;
+ }
- public void setComments(String comments) {
- this.comments = comments;
- }
+ public void setComments(String comments) {
+ this.comments = comments;
+ }
- /**
- * Where this service is available. Possible values are NCM, NODE.
- *
- * @return
+ /**
+ * @return Where this service is available. Possible values are NCM, NODE
*/
public String getAvailability() {
return availability;
@@ -96,8 +88,8 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * The state of this controller service. Possible values are ENABLED, ENABLING, DISABLED, DISABLING.
- * @return
+ * @return The state of this controller service. Possible values are ENABLED,
+ * ENABLING, DISABLED, DISABLING
*/
public String getState() {
return state;
@@ -108,9 +100,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * The controller service properties.
- *
- * @return
+ * @return controller service properties
*/
public Map<String, String> getProperties() {
return properties;
@@ -121,9 +111,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * The descriptors for the controller service properties.
- *
- * @return
+ * @return descriptors for the controller service properties
*/
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
@@ -134,10 +122,8 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * Returns the URL for this controller services custom configuration UI
- * if applicable. Null otherwise.
- *
- * @return
+ * @return the URL for this controller services custom configuration UI if
+ * applicable. Null otherwise
*/
public String getCustomUiUrl() {
return customUiUrl;
@@ -148,9 +134,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * The annotation data for this controller service.
- *
- * @return
+ * @return annotation data for this controller service
*/
public String getAnnotationData() {
return annotationData;
@@ -161,9 +145,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * All components referencing this controller service.
- *
- * @return
+ * @return all components referencing this controller service
*/
public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() {
return referencingComponents;
@@ -174,9 +156,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
}
/**
- * Gets the validation errors from this controller service. These validation errors
- * represent the problems with the controller service that must be resolved before it
- * can be enabled.
+ * Gets the validation errors from this controller service. These validation
+ * errors represent the problems with the controller service that must be
+ * resolved before it can be enabled.
*
* @return The validation errors
*/
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java
index 7fc57ff..4b557e1 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java
@@ -28,6 +28,7 @@ import javax.xml.bind.annotation.XmlType;
*/
@XmlType(name = "controllerServiceReferencingComponent")
public class ControllerServiceReferencingComponentDTO {
+
private String groupId;
private String id;
private String name;
@@ -36,20 +37,18 @@ public class ControllerServiceReferencingComponentDTO {
private Map<String, String> properties;
private Map<String, PropertyDescriptorDTO> descriptors;
-
+
private Collection<String> validationErrors;
-
+
private String referenceType;
private Integer activeThreadCount;
-
+
private Boolean referenceCycle;
private Set<ControllerServiceReferencingComponentDTO> referencingComponents;
/**
- * Group id for this component referencing a controller service. If this
- * component is another service, this field is blank.
- *
- * @return
+ * @return Group id for this component referencing a controller service. If this
+ * component is another service, this field is blank
*/
public String getGroupId() {
return groupId;
@@ -60,9 +59,7 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The id for this component referencing a controller service.
- *
- * @return
+ * @return id for this component referencing a controller service
*/
public String getId() {
return id;
@@ -73,9 +70,7 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The name for this component referencing a controller service.
- *
- * @return
+ * @return name for this component referencing a controller service
*/
public String getName() {
return name;
@@ -86,9 +81,7 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The type for this component referencing a controller service.
- *
- * @return
+ * @return type for this component referencing a controller service
*/
public String getType() {
return type;
@@ -99,10 +92,8 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The state of the processor referencing a controller service. If this
- * component is another service, this field is blank.
- *
- * @return
+ * @return state of the processor referencing a controller service. If this
+ * component is another service, this field is blank
*/
public String getState() {
return state;
@@ -113,8 +104,8 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The type of reference this is (Processor, ControllerService, or ReportingTask).
- * @return
+ * @return type of reference this is (Processor, ControllerService, or
+ * ReportingTask)
*/
public String getReferenceType() {
return referenceType;
@@ -125,9 +116,7 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The component properties.
- *
- * @return
+ * @return component properties
*/
public Map<String, String> getProperties() {
return properties;
@@ -138,9 +127,7 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * The descriptors for the components properties.
- *
- * @return
+ * @return descriptors for the components properties
*/
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
@@ -149,11 +136,9 @@ public class ControllerServiceReferencingComponentDTO {
public void setDescriptors(Map<String, PropertyDescriptorDTO> descriptors) {
this.descriptors = descriptors;
}
-
+
/**
- * Any validation error associated with this component.
- *
- * @return
+ * @return Any validation error associated with this component
*/
public Collection<String> getValidationErrors() {
return validationErrors;
@@ -162,11 +147,9 @@ public class ControllerServiceReferencingComponentDTO {
public void setValidationErrors(Collection<String> validationErrors) {
this.validationErrors = validationErrors;
}
-
+
/**
- * The active thread count for the referencing component.
- *
- * @return
+ * @return active thread count for the referencing component
*/
public Integer getActiveThreadCount() {
return activeThreadCount;
@@ -177,10 +160,8 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * If this referencing component represents a ControllerService, these
- * are the components that reference it.
- *
- * @return
+ * @return If this referencing component represents a ControllerService, these are
+ * the components that reference it
*/
public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() {
return referencingComponents;
@@ -191,10 +172,8 @@ public class ControllerServiceReferencingComponentDTO {
}
/**
- * If this referencing component represents a ControllerService, this indicates
- * whether it has already been represented in this hierarchy.
- *
- * @return
+ * @return If this referencing component represents a ControllerService, this
+ * indicates whether it has already been represented in this hierarchy
*/
public Boolean getReferenceCycle() {
return referenceCycle;
@@ -204,4 +183,4 @@ public class ControllerServiceReferencingComponentDTO {
this.referenceCycle = referenceCycle;
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java
index 10ea41d..2df4dd4 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java
@@ -32,9 +32,7 @@ public class CounterDTO {
private String value;
/**
- * The context of the counter.
- *
- * @return
+ * @return context of the counter
*/
public String getContext() {
return context;
@@ -45,9 +43,7 @@ public class CounterDTO {
}
/**
- * The id of the counter.
- *
- * @return
+ * @return id of the counter
*/
public String getId() {
return id;
@@ -58,9 +54,7 @@ public class CounterDTO {
}
/**
- * The name of the counter
- *
- * @return
+ * @return name of the counter
*/
public String getName() {
return name;
@@ -71,9 +65,7 @@ public class CounterDTO {
}
/**
- * The value for the counter
- *
- * @return
+ * @return value for the counter
*/
public String getValue() {
return value;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java
index ac1aa38..d9f45e3 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java
@@ -33,9 +33,7 @@ public class CountersDTO {
private Collection<CounterDTO> counters;
/**
- * Gets the collection of counters.
- *
- * @return
+ * @return the collection of counters
*/
public Collection<CounterDTO> getCounters() {
return counters;
@@ -46,9 +44,7 @@ public class CountersDTO {
}
/**
- * Gets the date/time that this report was generated.
- *
- * @return
+ * @return the date/time that this report was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
public Date getGenerated() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java
index 6e4aeb9..2241d62 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java
@@ -30,9 +30,7 @@ public class DocumentedTypeDTO {
private Set<String> tags;
/**
- * An optional description of the corresponding type.
- *
- * @return
+ * @return An optional description of the corresponding type
*/
public String getDescription() {
return description;
@@ -43,9 +41,7 @@ public class DocumentedTypeDTO {
}
/**
- * The type is the fully-qualified name of a Java class.
- *
- * @return
+ * @return The type is the fully-qualified name of a Java class
*/
public String getType() {
return type;
@@ -56,9 +52,7 @@ public class DocumentedTypeDTO {
}
/**
- * The tags associated with this type.
- *
- * @return
+ * @return The tags associated with this type
*/
public Set<String> getTags() {
return tags;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java
index 47a6871..5aec78f 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java
@@ -35,11 +35,9 @@ public class FlowSnippetDTO {
private Set<LabelDTO> labels = new LinkedHashSet<>();
private Set<FunnelDTO> funnels = new LinkedHashSet<>();
private Set<ControllerServiceDTO> controllerServices = new LinkedHashSet<>();
-
+
/**
- * The connections in this flow snippet.
- *
- * @return
+ * @return connections in this flow snippet
*/
public Set<ConnectionDTO> getConnections() {
return connections;
@@ -50,9 +48,7 @@ public class FlowSnippetDTO {
}
/**
- * The input ports in this flow snippet.
- *
- * @return
+ * @return input ports in this flow snippet
*/
public Set<PortDTO> getInputPorts() {
return inputPorts;
@@ -63,9 +59,7 @@ public class FlowSnippetDTO {
}
/**
- * The labels in this flow snippet.
- *
- * @return
+ * @return labels in this flow snippet
*/
public Set<LabelDTO> getLabels() {
return labels;
@@ -76,9 +70,7 @@ public class FlowSnippetDTO {
}
/**
- * The funnels in this flow snippet.
- *
- * @return
+ * @return funnels in this flow snippet
*/
public Set<FunnelDTO> getFunnels() {
return funnels;
@@ -89,9 +81,7 @@ public class FlowSnippetDTO {
}
/**
- * The output ports in this flow snippet.
- *
- * @return
+ * @return output ports in this flow snippet
*/
public Set<PortDTO> getOutputPorts() {
return outputPorts;
@@ -102,9 +92,7 @@ public class FlowSnippetDTO {
}
/**
- * The process groups in this flow snippet.
- *
- * @return
+ * @return process groups in this flow snippet
*/
public Set<ProcessGroupDTO> getProcessGroups() {
return processGroups;
@@ -115,9 +103,7 @@ public class FlowSnippetDTO {
}
/**
- * The processors in this flow group.
- *
- * @return
+ * @return processors in this flow group
*/
public Set<ProcessorDTO> getProcessors() {
return processors;
@@ -128,9 +114,7 @@ public class FlowSnippetDTO {
}
/**
- * The remote process groups in this flow snippet.
- *
- * @return
+ * @return remote process groups in this flow snippet
*/
public Set<RemoteProcessGroupDTO> getRemoteProcessGroups() {
return remoteProcessGroups;
@@ -141,8 +125,7 @@ public class FlowSnippetDTO {
}
/**
- * Returns the Controller Services in this flow snippet
- * @return
+ * @return the Controller Services in this flow snippet
*/
public Set<ControllerServiceDTO> getControllerServices() {
return controllerServices;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java
index f50c792..7f6ed25 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java
@@ -53,9 +53,7 @@ public class LabelDTO extends NiFiComponentDTO {
}
/**
- * The style for this label.
- *
- * @return
+ * @return style for this label
*/
public Map<String, String> getStyle() {
return style;
@@ -66,9 +64,7 @@ public class LabelDTO extends NiFiComponentDTO {
}
/**
- * The height of the label in pixels when at a 1:1 scale.
- *
- * @return
+ * @return height of the label in pixels when at a 1:1 scale
*/
public Double getHeight() {
return height;
@@ -79,9 +75,7 @@ public class LabelDTO extends NiFiComponentDTO {
}
/**
- * The width of the label in pixels when at a 1:1 scale.
- *
- * @return
+ * @return width of the label in pixels when at a 1:1 scale
*/
public Double getWidth() {
return width;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java
index 2829287..1ed0676 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java
@@ -55,9 +55,8 @@ public class NiFiComponentDTO {
}
/**
- * The id for the parent group of this component if applicable, null otherwise.
- *
- * @return
+ * @return id for the parent group of this component if applicable, null
+ * otherwise
*/
public String getParentGroupId() {
return parentGroupId;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
index 9499c2e..6aae62f 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
@@ -41,9 +41,7 @@ public class NodeDTO {
private Date nodeStartTime;
/**
- * The node's last heartbeat timestamp.
- *
- * @return
+ * @return node's last heartbeat timestamp
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
public Date getHeartbeat() {
@@ -55,9 +53,7 @@ public class NodeDTO {
}
/**
- * The time of the node's last connection request.
- *
- * @return
+ * @return time of the node's last connection request
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
public Date getConnectionRequested() {
@@ -82,9 +78,7 @@ public class NodeDTO {
}
/**
- * The queue for the controller.
- *
- * @return
+ * @return queue for the controller
*/
public String getQueued() {
return queued;
@@ -95,9 +89,7 @@ public class NodeDTO {
}
/**
- * The node's host/IP address.
- *
- * @return
+ * @return node's host/IP address
*/
public String getAddress() {
return address;
@@ -108,9 +100,7 @@ public class NodeDTO {
}
/**
- * The node ID.
- *
- * @return
+ * @return node ID
*/
public String getNodeId() {
return nodeId;
@@ -121,9 +111,7 @@ public class NodeDTO {
}
/**
- * The port the node is listening for API requests.
- *
- * @return
+ * @return port the node is listening for API requests
*/
public Integer getApiPort() {
return apiPort;
@@ -134,9 +122,7 @@ public class NodeDTO {
}
/**
- * The node's status.
- *
- * @return
+ * @return node's status
*/
public String getStatus() {
return status;
@@ -147,9 +133,7 @@ public class NodeDTO {
}
/**
- * The node's events.
- *
- * @return
+ * @return node's events
*/
public List<NodeEventDTO> getEvents() {
return events;
@@ -160,9 +144,7 @@ public class NodeDTO {
}
/**
- * Whether this node is the primary node within the cluster.
- *
- * @return
+ * @return whether this node is the primary node within the cluster
*/
public Boolean isPrimary() {
return primary;
@@ -173,9 +155,7 @@ public class NodeDTO {
}
/**
- * The time at which this Node was last restarted
- *
- * @return
+ * @return time at which this Node was last restarted
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
public Date getNodeStartTime() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java
index 3cad8d8..7d8273f 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java
@@ -32,9 +32,7 @@ public class NodeEventDTO {
private String message;
/**
- * The category of the node event.
- *
- * @return
+ * @return category of the node event
*/
public String getCategory() {
return category;
@@ -45,9 +43,7 @@ public class NodeEventDTO {
}
/**
- * The message of the node event.
- *
- * @return
+ * @return message of the node event
*/
public String getMessage() {
return message;
@@ -58,9 +54,7 @@ public class NodeEventDTO {
}
/**
- * The timestamp of the node event.
- *
- * @return
+ * @return timestamp of the node event
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
public Date getTimestamp() {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java
index 8c83331..f7aff79 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java
@@ -28,9 +28,7 @@ public class NodeSystemDiagnosticsDTO {
private SystemDiagnosticsDTO systemDiagnostics;
/**
- * The node.
- *
- * @return
+ * @return the node
*/
public NodeDTO getNode() {
return node;
@@ -41,9 +39,7 @@ public class NodeSystemDiagnosticsDTO {
}
/**
- * The system diagnostics.
- *
- * @return
+ * @return the system diagnostics
*/
public SystemDiagnosticsDTO getSystemDiagnostics() {
return systemDiagnostics;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9faaef8c/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java
index 2a372f4..464beaf 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java
@@ -38,9 +38,7 @@ public class PortDTO extends NiFiComponentDTO {
private Collection<String> validationErrors;
/**
- * The name of this port.
- *
- * @return
+ * @return name of this port
*/
public String getName() {
return name;
@@ -51,10 +49,8 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * The state of this port. Possible states are 'RUNNING', 'STOPPED', and
- * 'DISABLED'.
- *
- * @return
+ * @return The state of this port. Possible states are 'RUNNING', 'STOPPED', and
+ * 'DISABLED'
*/
public String getState() {
return state;
@@ -67,7 +63,7 @@ public class PortDTO extends NiFiComponentDTO {
/**
* The type of port. Possible values are 'INPUT_PORT' or 'OUTPUT_PORT'.
*
- * @return
+ * @return The type of port
*/
public String getType() {
return type;
@@ -78,9 +74,7 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * The number of tasks that should be concurrently scheduled for this port.
- *
- * @return
+ * @return number of tasks that should be concurrently scheduled for this port
*/
public Integer getConcurrentlySchedulableTaskCount() {
return concurrentlySchedulableTaskCount;
@@ -91,9 +85,7 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * The comments for this port.
- *
- * @return
+ * @return comments for this port
*/
public String getComments() {
return comments;
@@ -104,10 +96,8 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * Whether this port has incoming or outgoing connections to a remote NiFi.
- * This is only applicable when the port is running on the root group.
- *
- * @return
+ * @return whether this port has incoming or outgoing connections to a remote NiFi.
+ * This is only applicable when the port is running on the root group
*/
public Boolean isTransmitting() {
return transmitting;
@@ -118,9 +108,7 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * Groups that are allowed to access this port.
- *
- * @return
+ * @return groups that are allowed to access this port
*/
public Set<String> getGroupAccessControl() {
return groupAccessControl;
@@ -131,9 +119,7 @@ public class PortDTO extends NiFiComponentDTO {
}
/**
- * Users that are allowed to access this port.
- *
- * @return
+ * @return users that are allowed to access this port
*/
public Set<String> getUserAccessControl() {
return userAccessControl;