You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by rz...@apache.org on 2023/08/28 06:27:24 UTC
[storm] branch master updated (59769f1d1 -> 4521994fd)
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
from 59769f1d1 STORM-3885 - License Adjustment
new 911afe2c0 STORM-3937 - Fix errors/warnings found while generating javadoc in storm-starter
new 2439a2b69 STORM-3936 - Fix errors/warnings found while generating javadoc in storm-kafka-client
new a798cd6f6 STORM-3935 - Fix errors/warnings found while generating javadoc in storm-cassandra
new 2ec7a7413 STORM-3934 - Fix errors/warnings found while generating javadoc in storm-webapps (documents impl details)
new fc7bd5f68 STORM-3933 - Fix errors/warnings found while generating javadoc in storm-server
new 4521994fd STORM-3932 - Fix errors/warnings found while generating javadoc in storm-client
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../storm/starter/SlidingWindowTopology.java | 4 ++--
.../storm/starter/streams/TypedTupleExample.java | 2 +-
.../storm/starter/tools/SlidingWindowCounter.java | 7 +++---
.../apache/storm/cassandra/context/WorkerCtx.java | 4 ++--
.../org/apache/storm/kafka/bolt/KafkaBolt.java | 4 ++--
.../org/apache/storm/kafka/spout/KafkaTuple.java | 2 +-
.../kafka/spout/subscription/TopicAssigner.java | 2 --
storm-client/src/jvm/org/apache/storm/Config.java | 26 ++++++++++-----------
.../src/jvm/org/apache/storm/ILocalCluster.java | 4 ++--
.../jvm/org/apache/storm/blobstore/BlobStore.java | 1 -
.../org/apache/storm/cluster/IStateStorage.java | 1 -
.../apache/storm/cluster/IStormClusterState.java | 27 +++++++++++-----------
.../jvm/org/apache/storm/metric/api/IMetric.java | 7 +++---
.../src/jvm/org/apache/storm/streams/Pair.java | 3 ---
.../jvm/org/apache/storm/streams/PairStream.java | 20 ----------------
.../org/apache/storm/streams/StreamBuilder.java | 6 -----
.../streams/operations/CombinerAggregator.java | 6 -----
.../storm/streams/operations/StateUpdater.java | 5 ----
.../org/apache/storm/topology/TopologyBuilder.java | 3 +--
.../src/jvm/org/apache/storm/trident/Stream.java | 2 --
.../storm/trident/operation/ITridentResource.java | 3 +--
.../apache/storm/utils/DefaultShellLogHandler.java | 2 --
.../src/jvm/org/apache/storm/utils/Utils.java | 1 -
.../jvm/org/apache/storm/utils/VersionedStore.java | 2 +-
.../apache/storm/metric/timed/TimerDecorated.java | 2 +-
.../nimbus/AssignmentDistributionService.java | 1 -
.../storm/nimbus/LeaderListenerCallback.java | 3 ++-
.../scheduling/BaseResourceAwareStrategy.java | 2 +-
.../strategies/scheduling/ObjectResourcesItem.java | 7 +++---
.../strategies/scheduling/sorter/NodeSorter.java | 16 ++++---------
.../scheduling/sorter/NodeSorterHostProximity.java | 21 +++++------------
.../main/java/org/apache/storm/utils/EnumUtil.java | 2 --
.../handler/LogviewerLogDownloadHandler.java | 5 ++--
.../logviewer/handler/LogviewerProfileHandler.java | 1 -
.../logviewer/utils/LogviewerResponseBuilder.java | 1 -
.../storm/daemon/utils/ListFunctionalSupport.java | 1 -
.../org/apache/storm/daemon/utils/StreamUtil.java | 1 -
37 files changed, 67 insertions(+), 140 deletions(-)
[storm] 04/06: STORM-3934 - Fix errors/warnings found while generating javadoc in storm-webapps (documents impl details)
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit 2ec7a7413bc837e809f3bab96ca5235024658862
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 09:44:14 2023 +0200
STORM-3934 - Fix errors/warnings found while generating javadoc in storm-webapps (documents impl details)
---
.../storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java | 5 ++---
.../storm/daemon/logviewer/handler/LogviewerProfileHandler.java | 1 -
.../storm/daemon/logviewer/utils/LogviewerResponseBuilder.java | 1 -
.../java/org/apache/storm/daemon/utils/ListFunctionalSupport.java | 1 -
.../src/main/java/org/apache/storm/daemon/utils/StreamUtil.java | 1 -
5 files changed, 2 insertions(+), 7 deletions(-)
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
index f65b16cd0..0aae783d1 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
@@ -47,13 +47,13 @@ public class LogviewerLogDownloadHandler {
}
/**
- * Download an worker log.
+ * Download a worker log.
*
* @param host host address
* @param fileName file to download
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)}
+ *
*/
public Response downloadLogFile(String host, String fileName, String user) throws IOException {
workerLogs.setLogFilePermission(fileName);
@@ -67,7 +67,6 @@ public class LogviewerLogDownloadHandler {
* @param fileName file to download
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)}
*/
public Response downloadDaemonLogFile(String host, String fileName, String user) throws IOException {
return logFileDownloadHelper.downloadFile(host, fileName, user, true);
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
index c68ab3c81..f4bc03a1d 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
@@ -107,7 +107,6 @@ public class LogviewerProfileHandler {
* @param fileName dump file name
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link org.apache.storm.daemon.logviewer.utils.LogFileDownloader#downloadFile(String, String, String, boolean)}
*/
public Response downloadDumpFile(String topologyId, String hostPort, String fileName, String user) throws IOException {
String[] hostPortSplit = hostPort.split(":");
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
index a44c82566..9d7a85c1b 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
@@ -65,7 +65,6 @@ public class LogviewerResponseBuilder {
* @param entity entity object to represent it as JSON
* @param callback callbackParameterName for JSONP
* @param origin origin
- * @see {@link JsonResponseBuilder}
*/
public static Response buildSuccessJsonResponse(Object entity, String callback, String origin) {
return new JsonResponseBuilder().setData(entity).setCallback(callback)
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java
index 700fbb700..ed6622bb9 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java
@@ -97,7 +97,6 @@ public class ListFunctionalSupport {
/**
* Drop the only first element and create a new list. equivalent to drop(list, 1).
*
- * @see {@link ListFunctionalSupport#drop(List, int)}
* @param list the list
* @return newly created sublist that drops the first element from origin list. null if list is null.
*/
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java
index 8e8b5d099..adfd075c6 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java
@@ -33,7 +33,6 @@ public class StreamUtil {
* <p/>
* FileInputStream#skip may not work the first time, so ensure it successfully skips the given number of bytes.
*
- * @see {@link java.io.FileInputStream#skip(long)}
* @param stream the stream to skip
* @param n bytes to skip
*/
[storm] 03/06: STORM-3935 - Fix errors/warnings found while generating javadoc in storm-cassandra
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit a798cd6f65857ce189e56c3a10be326f38ba0ab4
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 09:42:19 2023 +0200
STORM-3935 - Fix errors/warnings found while generating javadoc in storm-cassandra
---
.../src/main/java/org/apache/storm/cassandra/context/WorkerCtx.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/external/storm-cassandra/src/main/java/org/apache/storm/cassandra/context/WorkerCtx.java b/external/storm-cassandra/src/main/java/org/apache/storm/cassandra/context/WorkerCtx.java
index a6f771bf0..1f5370d1c 100644
--- a/external/storm-cassandra/src/main/java/org/apache/storm/cassandra/context/WorkerCtx.java
+++ b/external/storm-cassandra/src/main/java/org/apache/storm/cassandra/context/WorkerCtx.java
@@ -66,9 +66,9 @@ public class WorkerCtx implements Serializable {
*
* @param clazz the class of the bean.
* @param topoConf the storm configuration
- * @param force if <code>true</code>= create a new instance even if one already exist.
+ * @param force if {@code true}, create a new instance even if one already exist.
*
- * @return a instance of type {@link T}.
+ * @return an instance of the given type {@code T}.
*/
public <T, K, V> T getWorkerBean(Class<T> clazz, Map<K, V> topoConf, boolean force) {
if (force) {
[storm] 01/06: STORM-3937 - Fix errors/warnings found while generating javadoc in storm-starter
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit 911afe2c0db2dbbaf1aabf5842abebe5931d06e6
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 09:35:08 2023 +0200
STORM-3937 - Fix errors/warnings found while generating javadoc in storm-starter
---
.../src/jvm/org/apache/storm/starter/SlidingWindowTopology.java | 4 ++--
.../src/jvm/org/apache/storm/starter/streams/TypedTupleExample.java | 2 +-
.../src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java | 4 +++-
3 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/examples/storm-starter/src/jvm/org/apache/storm/starter/SlidingWindowTopology.java b/examples/storm-starter/src/jvm/org/apache/storm/starter/SlidingWindowTopology.java
index a75f9995c..fda309df7 100644
--- a/examples/storm-starter/src/jvm/org/apache/storm/starter/SlidingWindowTopology.java
+++ b/examples/storm-starter/src/jvm/org/apache/storm/starter/SlidingWindowTopology.java
@@ -58,8 +58,8 @@ public class SlidingWindowTopology {
StormSubmitter.submitTopologyWithProgressBar(topoName, conf, builder.createTopology());
}
- /*
- * Computes tumbling window average
+ /**
+ * Computes tumbling window average.
*/
private static class TumblingWindowAvgBolt extends BaseWindowedBolt {
private OutputCollector collector;
diff --git a/examples/storm-starter/src/jvm/org/apache/storm/starter/streams/TypedTupleExample.java b/examples/storm-starter/src/jvm/org/apache/storm/starter/streams/TypedTupleExample.java
index e37e66658..f3e8a5ac5 100644
--- a/examples/storm-starter/src/jvm/org/apache/storm/starter/streams/TypedTupleExample.java
+++ b/examples/storm-starter/src/jvm/org/apache/storm/starter/streams/TypedTupleExample.java
@@ -25,7 +25,7 @@ import org.apache.storm.streams.windowing.TumblingWindows;
import org.apache.storm.topology.base.BaseWindowedBolt.Count;
/**
- * An example that illustrates the usage of typed tuples (TupleN<..>) and {@link TupleValueMappers}.
+ * An example that illustrates the usage of typed tuples (TupleN<..>) and {@link TupleValueMappers}.
*/
public class TypedTupleExample {
diff --git a/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java b/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
index 4ab8488d9..e454ae8d4 100644
--- a/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
+++ b/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
@@ -12,6 +12,8 @@
package org.apache.storm.starter.tools;
+import org.apache.storm.starter.bolt.RollingCountBolt;
+
import java.io.Serializable;
import java.util.Map;
@@ -19,7 +21,7 @@ import java.util.Map;
* This class counts objects in a sliding window fashion.
* <p/>
* It is designed 1) to give multiple "producer" threads write access to the counter, i.e. being able to increment
- * counts of objects, and 2) to give a single "consumer" thread (e.g. {@link PeriodicSlidingWindowCounter}) read access
+ * counts of objects, and 2) to give a single "consumer" thread (e.g. {@link RollingCountBolt}) read access
* to the counter. Whenever the consumer thread performs a read operation, this class will advance the head slot of the
* sliding window counter. This means that the consumer thread indirectly controls where writes of the producer threads
* will go to. Also, by itself this class will not advance the head slot.
[storm] 02/06: STORM-3936 - Fix errors/warnings found while generating javadoc in storm-kafka-client
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit 2439a2b69e3acd1cf908af2253cc82eebf835055
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 09:38:09 2023 +0200
STORM-3936 - Fix errors/warnings found while generating javadoc in storm-kafka-client
---
.../src/main/java/org/apache/storm/kafka/bolt/KafkaBolt.java | 4 ++--
.../src/main/java/org/apache/storm/kafka/spout/KafkaTuple.java | 2 +-
.../java/org/apache/storm/kafka/spout/subscription/TopicAssigner.java | 2 --
3 files changed, 3 insertions(+), 5 deletions(-)
diff --git a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/bolt/KafkaBolt.java b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/bolt/KafkaBolt.java
index f3fc80805..498499965 100644
--- a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/bolt/KafkaBolt.java
+++ b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/bolt/KafkaBolt.java
@@ -66,11 +66,11 @@ public class KafkaBolt<K, V> extends BaseTickTupleAwareRichBolt {
private PreparableCallback providedCallback;
private Properties boltSpecifiedProperties = new Properties();
/**
- * {@see KafkaBolt#setFireAndForget(boolean)} for more details on this.
+ * {@link KafkaBolt#setFireAndForget(boolean)} for more details on this.
*/
private boolean fireAndForget = false;
/**
- * {@see KafkaBolt#setAsync(boolean)} for more details on this.
+ * {@link KafkaBolt#setAsync(boolean)} for more details on this.
*/
private boolean async = true;
diff --git a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaTuple.java b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaTuple.java
index 02085f22b..2efb6a332 100644
--- a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaTuple.java
+++ b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaTuple.java
@@ -22,7 +22,7 @@ import org.apache.storm.tuple.Values;
/**
* A list of Values in a tuple that can be routed
- * to a given stream. {@see org.apache.storm.kafka.spout.RecordTranslator#apply}
+ * to a given stream: {@link org.apache.storm.kafka.spout.RecordTranslator#apply}.
*/
public class KafkaTuple extends Values {
private static final long serialVersionUID = 4803794470450587992L;
diff --git a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/subscription/TopicAssigner.java b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/subscription/TopicAssigner.java
index b8f931364..2101dbf44 100644
--- a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/subscription/TopicAssigner.java
+++ b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/subscription/TopicAssigner.java
@@ -31,8 +31,6 @@ public class TopicAssigner implements Serializable {
/**
* Assign partitions to the KafkaConsumer.
- * @param <K> The consumer key type
- * @param <V> The consumer value type
* @param consumer The Kafka consumer to assign partitions to
* @param newAssignment The partitions to assign.
* @param listener The rebalance listener to call back on when the assignment changes
[storm] 06/06: STORM-3932 - Fix errors/warnings found while generating javadoc in storm-client
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit 4521994fd72c9860d138ee14f17c0bf65c795d72
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 10:03:53 2023 +0200
STORM-3932 - Fix errors/warnings found while generating javadoc in storm-client
---
.../storm/starter/tools/SlidingWindowCounter.java | 9 ++++----
storm-client/src/jvm/org/apache/storm/Config.java | 26 ++++++++++-----------
.../src/jvm/org/apache/storm/ILocalCluster.java | 4 ++--
.../jvm/org/apache/storm/blobstore/BlobStore.java | 1 -
.../org/apache/storm/cluster/IStateStorage.java | 1 -
.../apache/storm/cluster/IStormClusterState.java | 27 +++++++++++-----------
.../jvm/org/apache/storm/metric/api/IMetric.java | 7 +++---
.../src/jvm/org/apache/storm/streams/Pair.java | 3 ---
.../jvm/org/apache/storm/streams/PairStream.java | 20 ----------------
.../org/apache/storm/streams/StreamBuilder.java | 6 -----
.../streams/operations/CombinerAggregator.java | 6 -----
.../storm/streams/operations/StateUpdater.java | 5 ----
.../org/apache/storm/topology/TopologyBuilder.java | 3 +--
.../src/jvm/org/apache/storm/trident/Stream.java | 2 --
.../storm/trident/operation/ITridentResource.java | 3 +--
.../apache/storm/utils/DefaultShellLogHandler.java | 2 --
.../src/jvm/org/apache/storm/utils/Utils.java | 1 -
.../jvm/org/apache/storm/utils/VersionedStore.java | 2 +-
.../storm/nimbus/LeaderListenerCallback.java | 2 ++
.../strategies/scheduling/sorter/NodeSorter.java | 3 ++-
.../scheduling/sorter/NodeSorterHostProximity.java | 5 ++--
21 files changed, 47 insertions(+), 91 deletions(-)
diff --git a/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java b/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
index e454ae8d4..136d586ab 100644
--- a/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
+++ b/examples/storm-starter/src/jvm/org/apache/storm/starter/tools/SlidingWindowCounter.java
@@ -12,18 +12,17 @@
package org.apache.storm.starter.tools;
-import org.apache.storm.starter.bolt.RollingCountBolt;
-
import java.io.Serializable;
import java.util.Map;
+
/**
* This class counts objects in a sliding window fashion.
* <p/>
* It is designed 1) to give multiple "producer" threads write access to the counter, i.e. being able to increment
- * counts of objects, and 2) to give a single "consumer" thread (e.g. {@link RollingCountBolt}) read access
- * to the counter. Whenever the consumer thread performs a read operation, this class will advance the head slot of the
- * sliding window counter. This means that the consumer thread indirectly controls where writes of the producer threads
+ * counts of objects, and 2) to give a single "consumer" thread (e.g. {@link org.apache.storm.starter.bolt.RollingCountBolt})
+ * read access to the counter. Whenever the consumer thread performs a read operation, this class will advance the head slot
+ * of the sliding window counter. This means that the consumer thread indirectly controls where writes of the producer threads
* will go to. Also, by itself this class will not advance the head slot.
* <p/>
* A note for analyzing data based on a sliding window count: During the initial <code>windowLengthInSlots</code>
diff --git a/storm-client/src/jvm/org/apache/storm/Config.java b/storm-client/src/jvm/org/apache/storm/Config.java
index 93973fcc6..7837cf5ef 100644
--- a/storm-client/src/jvm/org/apache/storm/Config.java
+++ b/storm-client/src/jvm/org/apache/storm/Config.java
@@ -131,10 +131,9 @@ public class Config extends HashMap<String, Object> {
public static final String TASK_CREDENTIALS_POLL_SECS = "task.credentials.poll.secs";
/**
* Whether to enable backpressure in for a certain topology.
- *
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsBoolean
public static final String TOPOLOGY_BACKPRESSURE_ENABLE = "topology.backpressure.enable";
/**
@@ -860,16 +859,17 @@ public class Config extends HashMap<String, Object> {
public static final String STORM_DO_AS_USER = "storm.doAsUser";
/**
* The maximum number of machines that should be used by this topology. This configuration can
- * be used to isolate topologies from each other. See {@link org.apache.storm.scheduler.multitenant.MultitenantScheduler}.
+ * be used to isolate topologies from each other. See {@code org.apache.storm.scheduler.multitenant.MultitenantScheduler}.
* Round Robin Strategy uses this value to avoid spreading a topology too
- * thinly over a large number of machines - avoiding the the extreme case where the topology would be spread over
+ * thinly over a large number of machines - avoiding the extreme case where the topology would be spread over
* all workers and thus deny scheduling of other topologies. Round Robin scheduling will occupy all the workers on
* this limited number of machines, forcing other topologies to be scheduled on other machines; thus isolating the
* topology from other topologies.
- * Set storm.scheduler to {@link org.apache.storm.scheduler.multitenant.MultitenantScheduler}
- * Alternatively set storm.scheduler to {@link org.apache.storm.scheduler.resource.ResourceAwareScheduler}
- * using {@link #TOPOLOGY_SCHEDULER_STRATEGY} set to
- * {@link org.apache.storm.scheduler.resource.strategies.scheduling.RoundRobinResourceAwareStrategy} */
+ * Set {@code storm.scheduler} to {@code org.apache.storm.scheduler.multitenant.MultitenantScheduler}
+ * Alternatively set {@code storm.scheduler} to {@code org.apache.storm.scheduler.resource.ResourceAwareScheduler}
+ * using {@link Config#TOPOLOGY_SCHEDULER_STRATEGY} set to
+ * {@code org.apache.storm.scheduler.resource.strategies.scheduling.RoundRobinResourceAwareStrategy}
+ * */
@IsInteger
@IsPositiveNumber
public static final String TOPOLOGY_ISOLATED_MACHINES = "topology.isolate.machines";
@@ -1237,9 +1237,9 @@ public class Config extends HashMap<String, Object> {
/**
* Configure the topology metrics reporters to be used on workers.
- * @deprecated Use {@link Config#TOPOLOGY_METRICS_REPORTERS} instead.
+ * Use {@link Config#TOPOLOGY_METRICS_REPORTERS} instead.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsListEntryCustom(entryValidatorClasses = { MetricReportersValidator.class })
public static final String STORM_METRICS_REPORTERS = "storm.metrics.reporters";
@@ -1268,9 +1268,9 @@ public class Config extends HashMap<String, Object> {
* If the instance field of the principal is the string "_HOST", it will
* be replaced with the host name of the server the daemon is running on
* (by calling {@link #getBlobstoreHDFSPrincipal(Map conf)} method).
- * @Deprecated Use {@link Config#STORM_HDFS_LOGIN_PRINCIPAL} instead.
+ * Note: Use {@link Config#STORM_HDFS_LOGIN_PRINCIPAL} instead.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsString
public static final String BLOBSTORE_HDFS_PRINCIPAL = "blobstore.hdfs.principal";
/**
diff --git a/storm-client/src/jvm/org/apache/storm/ILocalCluster.java b/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
index 687be64df..8e7cfa8f4 100644
--- a/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
+++ b/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
@@ -79,7 +79,7 @@ public interface ILocalCluster extends AutoCloseable {
* @param options for how to kill the topology
* @throws TException on any error from nimbus
*/
- void killTopologyWithOpts(String name, KillOptions options) throws TException;
+ void killTopologyWithOpts(String topologyName, KillOptions options) throws TException;
/**
* Activate a topology.
@@ -203,7 +203,7 @@ public interface ILocalCluster extends AutoCloseable {
* @param secs the number of seconds to advance time
* @param steps the number of steps we should take when advancing simulated time
*/
- void advanceClusterTime(int secs, int step) throws InterruptedException;
+ void advanceClusterTime(int secs, int steps) throws InterruptedException;
/**
* If the cluster is tracked get the id for the tracked cluster. This is intended for internal testing only.
diff --git a/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java b/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
index 5f415843f..8323884ae 100644
--- a/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
+++ b/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
@@ -256,7 +256,6 @@ public abstract class BlobStore implements Shutdownable, AutoCloseable {
* Filters keys based on the KeyFilter passed as the argument.
*
* @param filter KeyFilter
- * @param <R> Type
* @return Set of filtered keys
*/
public <R> Set<R> filterAndListKeys(KeyFilter<R> filter) {
diff --git a/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java b/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
index d0b45af42..61b4c82d3 100644
--- a/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
+++ b/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
@@ -64,7 +64,6 @@ public interface IStateStorage extends Closeable {
*
* @param path The path to create, along with all its parents.
* @param acls The acls to apply to the path. May be null.
- * @return path
*/
void mkdirs(String path, List<ACL> acls);
diff --git a/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java b/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
index 412c76170..d0987002c 100644
--- a/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
+++ b/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
@@ -61,14 +61,15 @@ public interface IStormClusterState {
Map<String, Assignment> assignmentsInfo();
/**
- * Sync the remote state store assignments to local backend, used when master gains leadership, see {@link LeaderListenerCallback}.
+ * Sync the remote state store assignments to local backend, used when master gains leadership,
+ * see {@code org.apache.storm.nimbus.LeaderListenerCallback}.
*
* @param remote assigned assignments for a specific {@link IStormClusterState} instance, usually a supervisor/node.
*/
void syncRemoteAssignments(Map<String, byte[]> remote);
/**
- * Flag to indicate if the assignments synced successfully, see {@link #syncRemoteAssignments(Map)}.
+ * Flag to indicate if the assignments synced successfully, see {@link IStormClusterState#syncRemoteAssignments(Map)}.
*
* @return true if is synced successfully
*/
@@ -82,7 +83,7 @@ public interface IStormClusterState {
boolean isPacemakerStateStore();
/**
- * Mark the assignments as synced successfully, see {@link #isAssignmentsBackendSynchronized()}.
+ * Mark the assignments as synced successfully, see {@link IStormClusterState#isAssignmentsBackendSynchronized()}.
*/
void setAssignmentsBackendSynchronized();
@@ -150,9 +151,9 @@ public interface IStormClusterState {
/**
* Get backpressure topologies.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
List<String> backpressureTopologies();
/**
@@ -178,30 +179,30 @@ public interface IStormClusterState {
/**
* Get topoloy backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
boolean topologyBackpressure(String stormId, long timeoutMs, Runnable callback);
/**
* Setup backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void setupBackpressure(String stormId, Map<String, Object> topoConf);
/**
* Remove backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void removeBackpressure(String stormId);
/**
* Remove worker backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void removeWorkerBackpressure(String stormId, String node, Long port);
void activateStorm(String stormId, StormBase stormBase, Map<String, Object> topoConf);
diff --git a/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java b/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
index b6670fcb2..20e7f2f05 100644
--- a/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
+++ b/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
@@ -18,9 +18,10 @@ package org.apache.storm.metric.api;
public interface IMetric {
/**
* Get value and reset.
- * @return an object that will be sent sent to {@link IMetricsConsumer#handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer
- * .TaskInfo,
- * java.util.Collection)}. If null is returned nothing will be sent. If this value can be reset, like with a counter, a side effect
+ *
+ * @return an object that will be sent to
+ * {@link IMetricsConsumer#handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer.TaskInfo,java.util.Collection)}.
+ * If {@code null} is returned nothing will be sent. If this value can be reset, like with a counter, a side effect
* of calling this should be that the value is reset.
*/
Object getValueAndReset();
diff --git a/storm-client/src/jvm/org/apache/storm/streams/Pair.java b/storm-client/src/jvm/org/apache/storm/streams/Pair.java
index ea065a4bb..bd513ac1e 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/Pair.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/Pair.java
@@ -16,9 +16,6 @@ import java.io.Serializable;
/**
* A pair of values.
- *
- * @param <T1> the type of the first value
- * @param <T2> the type of the second value
*/
public final class Pair<T1, T2> implements Serializable {
/**
diff --git a/storm-client/src/jvm/org/apache/storm/streams/PairStream.java b/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
index 14b88a05c..d2305564d 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
@@ -59,7 +59,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Returns a new stream by applying a {@link Function} to the value of each key-value pairs in this stream.
*
* @param function the mapping function
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> mapValues(Function<? super V, ? extends R> function) {
@@ -71,7 +70,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Return a new stream by applying a {@link FlatMapFunction} function to the value of each key-value pairs in this stream.
*
* @param function the flatmap function
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> flatMapValues(FlatMapFunction<? super V, ? extends R> function) {
@@ -85,7 +83,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* @param initialValue the initial value of the result
* @param accumulator the accumulator
* @param combiner the combiner
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> aggregateByKey(R initialValue,
@@ -98,8 +95,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Aggregates the values for each key of this stream using the given {@link CombinerAggregator}.
*
* @param aggregator the combiner aggregator
- * @param <A> the accumulator type
- * @param <R> the result type
* @return the new stream
*/
public <A, R> PairStream<K, R> aggregateByKey(CombinerAggregator<? super V, A, ? extends R> aggregator) {
@@ -180,7 +175,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> join(PairStream<K, V1> otherStream) {
@@ -195,8 +189,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> join(PairStream<K, V1> otherStream,
@@ -216,7 +208,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> leftOuterJoin(PairStream<K, V1> otherStream) {
@@ -231,8 +222,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> leftOuterJoin(PairStream<K, V1> otherStream,
@@ -252,7 +241,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> rightOuterJoin(PairStream<K, V1> otherStream) {
@@ -267,8 +255,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> rightOuterJoin(PairStream<K, V1> otherStream,
@@ -288,7 +274,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> fullOuterJoin(PairStream<K, V1> otherStream) {
@@ -303,8 +288,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> fullOuterJoin(PairStream<K, V1> otherStream,
@@ -352,7 +335,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* choose the state implementation.
*
* @param stateUpdateFn the state update function
- * @param <R> the result type
* @return the {@link StreamState} which can be used to query the state
*/
public <R> StreamState<K, R> updateStateByKey(R initialValue,
@@ -366,7 +348,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* choose the state implementation.
*
* @param stateUpdater the state updater
- * @param <R> the result type
* @return the {@link StreamState} which can be used to query the state
*/
public <R> StreamState<K, R> updateStateByKey(StateUpdater<? super V, ? extends R> stateUpdater) {
@@ -385,7 +366,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<Iterable<V>, Iterable<V1>>> coGroupByKey(PairStream<K, V1> otherStream) {
diff --git a/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java b/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
index 7827ada57..45ed897e8 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
@@ -103,7 +103,6 @@ public class StreamBuilder {
*
* @param spout the spout
* @param valueMapper the value mapper
- * @param <T> the type of values in the resultant stream
* @return the new stream
*/
public <T> Stream<T> newStream(IRichSpout spout, TupleValueMapper<T> valueMapper) {
@@ -118,7 +117,6 @@ public class StreamBuilder {
* @param spout the spout
* @param valueMapper the value mapper
* @param parallelism the parallelism of the stream
- * @param <T> the type of values in the resultant stream
* @return the new stream
*/
public <T> Stream<T> newStream(IRichSpout spout, TupleValueMapper<T> valueMapper, int parallelism) {
@@ -131,8 +129,6 @@ public class StreamBuilder {
*
* @param spout the spout
* @param pairValueMapper the pair value mapper
- * @param <K> the key type
- * @param <V> the value type
* @return the new stream of key-value pairs
*/
public <K, V> PairStream<K, V> newStream(IRichSpout spout, PairValueMapper<K, V> pairValueMapper) {
@@ -146,8 +142,6 @@ public class StreamBuilder {
* @param spout the spout
* @param pairValueMapper the pair value mapper
* @param parallelism the parallelism of the stream
- * @param <K> the key type
- * @param <V> the value type
* @return the new stream of key-value pairs
*/
public <K, V> PairStream<K, V> newStream(IRichSpout spout, PairValueMapper<K, V> pairValueMapper, int parallelism) {
diff --git a/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java b/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
index 926fd7d86..bb36fbe67 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
@@ -14,10 +14,6 @@ package org.apache.storm.streams.operations;
/**
* Interface for aggregating values.
- *
- * @param <T> the original value type
- * @param <A> the accumulator type
- * @param <R> the result type
*/
public interface CombinerAggregator<T, A, R> extends Operation {
/**
@@ -26,8 +22,6 @@ public interface CombinerAggregator<T, A, R> extends Operation {
* @param initialValue the initial value of the result to start with
* @param accumulator a function that accumulates values into a partial result
* @param combiner a function that combines partially accumulated results
- * @param <T> the value type
- * @param <R> the result type
* @return the {@link CombinerAggregator}
*/
static <T, R> CombinerAggregator<T, R, R> of(R initialValue,
diff --git a/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java b/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
index 7cc1601b2..bbdf08ef5 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
@@ -14,9 +14,6 @@ package org.apache.storm.streams.operations;
/**
* Interface for updating state.
- *
- * @param <T> the value type
- * @param <S> the state type
*/
public interface StateUpdater<T, S> extends Operation {
/**
@@ -24,8 +21,6 @@ public interface StateUpdater<T, S> extends Operation {
*
* @param initialValue the intial value of the state
* @param stateUpdateFn the state update function
- * @param <T> the value type
- * @param <S> the state type
* @return the {@link StateUpdater}
*/
static <T, S> StateUpdater<T, S> of(S initialValue,
diff --git a/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java b/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
index 0ef7afee0..309e7291e 100644
--- a/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
+++ b/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
@@ -330,8 +330,7 @@ public class TopologyBuilder {
* outputs.
* @param bolt the stateful windowed bolt
* @param parallelismHint the number of tasks that should be assigned to execute this bolt. Each task will run on a thread in a process
- * somwehere around the cluster.
- * @param <T> the type of the state (e.g. {@link org.apache.storm.state.KeyValueState})
+ * somewhere around the cluster.
* @return use the returned object to declare the inputs to this component
*
* @throws IllegalArgumentException if {@code parallelism_hint} is not positive
diff --git a/storm-client/src/jvm/org/apache/storm/trident/Stream.java b/storm-client/src/jvm/org/apache/storm/trident/Stream.java
index 3695d4669..d25053d3e 100644
--- a/storm-client/src/jvm/org/apache/storm/trident/Stream.java
+++ b/storm-client/src/jvm/org/apache/storm/trident/Stream.java
@@ -529,7 +529,6 @@ public class Stream implements IAggregatableStream, ResourceDeclarer<Stream> {
*
* @param inputFieldName input field name
* @param comparator comparator used in for finding minimum of two tuple values of {@code inputFieldName}.
- * @param <T> type of tuple's given input field value.
* @return the new stream with this operation.
*/
public <T> Stream minBy(String inputFieldName, Comparator<T> comparator) {
@@ -569,7 +568,6 @@ public class Stream implements IAggregatableStream, ResourceDeclarer<Stream> {
*
* @param inputFieldName input field name
* @param comparator comparator used in for finding maximum of two tuple values of {@code inputFieldName}.
- * @param <T> type of tuple's given input field value.
* @return the new stream with this operation.
*/
public <T> Stream maxBy(String inputFieldName, Comparator<T> comparator) {
diff --git a/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java b/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
index 8fd17f49e..f6c1d7866 100644
--- a/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
+++ b/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
@@ -18,8 +18,7 @@ import org.apache.storm.generated.SharedMemory;
/**
* This interface is implemented by various Trident classes in order to gather and propogate resources that have been set on them.
- *
- * @see ResourceDeclarer
+ * See {@link org.apache.storm.topology.ResourceDeclarer}
*/
public interface ITridentResource {
/**
diff --git a/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java b/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
index f0f3c7a26..96df6ae0a 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
@@ -45,7 +45,6 @@ public class DefaultShellLogHandler implements ShellLogHandler {
* @param ownerCls - the class which instantiated this ShellLogHandler.
* @param process - the current {@link ShellProcess}.
* @param context - the current {@link TopologyContext}.
- * @see {@link ShellLogHandler#setUpContext}
*/
@Override
public void setUpContext(final Class<?> ownerCls, final ShellProcess process,
@@ -60,7 +59,6 @@ public class DefaultShellLogHandler implements ShellLogHandler {
* Log the given message.
*
* @param shellMsg - the {@link ShellMsg} to log.
- * @see {@link ShellLogHandler#log}
*/
@Override
public void log(final ShellMsg shellMsg) {
diff --git a/storm-client/src/jvm/org/apache/storm/utils/Utils.java b/storm-client/src/jvm/org/apache/storm/utils/Utils.java
index 44072be5b..28472c64d 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/Utils.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/Utils.java
@@ -855,7 +855,6 @@ public class Utils {
*
* @param str the encoded string.
* @param clazz the thrift class we are expecting.
- * @param <T> The type of clazz
* @return the decoded object
*/
public static <T> T deserializeFromString(String str, Class<T> clazz) {
diff --git a/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java b/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
index 08d09f867..c4fd33f26 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
@@ -28,7 +28,7 @@ public class VersionedStore {
/**
* Creates a store at the given path.
*
- * @param The path for the store
+ * @param path The path for the store
* @param createRootDir option to create the path directory
*/
public VersionedStore(String path, boolean createRootDir) throws IOException {
diff --git a/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java b/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
index e9286c57b..40acc110f 100644
--- a/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
+++ b/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
@@ -69,6 +69,8 @@ public class LeaderListenerCallback {
private final int requeueDelayMs;
/**
+ * Creates a {@link LeaderListenerCallback}.
+ *
* @param conf config
* @param zk zookeeper CuratorFramework client
* @param blobStore BlobStore
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
index affd8e004..bff2394e6 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
@@ -160,7 +160,8 @@ public class NodeSorter implements INodeSorter {
* above will be ranked after racks that have more balanced resource availability and nodes or racks that have
* resources that are not requested will be ranked below . So we will be less likely to pick a rack that
* have a lot of one resource but a low amount of another and have a lot of resources that are not requested by the executor.
- * This is similar to logic used in {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * This is similar to logic used in
+ * {@link NodeSorter#sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
* </li>
*
* <li>
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
index 07a167223..c5acc9911 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
@@ -169,13 +169,14 @@ public class NodeSorterHostProximity implements INodeSorter {
* above will be ranked after racks that have more balanced resource availability and nodes or racks that have
* resources that are not requested will be ranked below . So we will be less likely to pick a rack that
* have a lot of one resource but a low amount of another and have a lot of resources that are not requested by the executor.
- * This is similar to logic used in {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * This is similar to logic used in
+ * {@link NodeSorterHostProximity#sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
* </li>
*
* <li>
* The tie between two nodes with same resource availability is broken by using the node with lower minimum
* percentage used. This comparison was used in {@link #sortObjectResourcesDefault(ObjectResourcesSummary, ExistingScheduleFunc)}
- * but here it is made subservient to modified resource availbility used in
+ * but here it is made subservient to modified resource availability used in
* {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
*
* </li>
[storm] 05/06: STORM-3933 - Fix errors/warnings found while generating javadoc in storm-server
Posted by rz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
commit fc7bd5f68e38a4ce88955f1db82fc173f6e5bcb6
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 09:50:25 2023 +0200
STORM-3933 - Fix errors/warnings found while generating javadoc in storm-server
---
.../org/apache/storm/metric/timed/TimerDecorated.java | 2 +-
.../storm/nimbus/AssignmentDistributionService.java | 1 -
.../apache/storm/nimbus/LeaderListenerCallback.java | 1 -
.../scheduling/BaseResourceAwareStrategy.java | 2 +-
.../strategies/scheduling/ObjectResourcesItem.java | 7 +++----
.../strategies/scheduling/sorter/NodeSorter.java | 15 +++------------
.../scheduling/sorter/NodeSorterHostProximity.java | 18 ++++--------------
.../src/main/java/org/apache/storm/utils/EnumUtil.java | 2 --
8 files changed, 12 insertions(+), 36 deletions(-)
diff --git a/storm-server/src/main/java/org/apache/storm/metric/timed/TimerDecorated.java b/storm-server/src/main/java/org/apache/storm/metric/timed/TimerDecorated.java
index 309519cce..abac63633 100644
--- a/storm-server/src/main/java/org/apache/storm/metric/timed/TimerDecorated.java
+++ b/storm-server/src/main/java/org/apache/storm/metric/timed/TimerDecorated.java
@@ -21,7 +21,7 @@ public interface TimerDecorated extends AutoCloseable {
long stopTiming();
/**
- * Stop the timer for measured object. (Copied from {@link Timer.Context#stop()})
+ * Stop the timer for measured object.
* Call to this method will not reset the start time.
* Multiple calls result in multiple updates.
*
diff --git a/storm-server/src/main/java/org/apache/storm/nimbus/AssignmentDistributionService.java b/storm-server/src/main/java/org/apache/storm/nimbus/AssignmentDistributionService.java
index ee9f1361c..e0645e5f8 100644
--- a/storm-server/src/main/java/org/apache/storm/nimbus/AssignmentDistributionService.java
+++ b/storm-server/src/main/java/org/apache/storm/nimbus/AssignmentDistributionService.java
@@ -107,7 +107,6 @@ public class AssignmentDistributionService implements Closeable {
* Function for initialization.
*
* @param conf config
- * @param callback callback for sendAssignment results
*/
public void prepare(Map conf, INodeAssignmentSentCallBack callBack) {
this.conf = conf;
diff --git a/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java b/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
index 08c7e9905..e9286c57b 100644
--- a/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
+++ b/storm-server/src/main/java/org/apache/storm/nimbus/LeaderListenerCallback.java
@@ -69,7 +69,6 @@ public class LeaderListenerCallback {
private final int requeueDelayMs;
/**
- * Constructor for {@LeaderListenerCallback}.
* @param conf config
* @param zk zookeeper CuratorFramework client
* @param blobStore BlobStore
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.java
index 94550a1fe..5f12557fe 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.java
@@ -75,7 +75,7 @@ public abstract class BaseResourceAwareStrategy implements IStrategy {
/**
* New and only node sorting type going forward.
- * {@link NodeSorterHostProximity#NodeSorterHostProximity(Cluster, TopologyDetails)} for more details
+ * See {@link NodeSorterHostProximity} for more details.
*/
COMMON,
}
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.java
index 7b4f7d291..6b87dbdb2 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.java
@@ -19,6 +19,7 @@
package org.apache.storm.scheduler.resource.strategies.scheduling;
import org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer;
+import org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorter;
/**
* class to keep track of resources on a rack or node.
@@ -33,8 +34,7 @@ public class ObjectResourcesItem {
* Note that nodes are grouped into hosts. Hosts into racks. And racks are grouped under the cluster.
*
* <p>
- * An example of this calculation is in
- * {@link NodeSorter#sortObjectResourcesCommon(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)}
+ * An example of this calculation is in {@link NodeSorter}
* where value is calculated by {@link ObjectResourcesSummary#getAvailableResourcesOverall()}
* using {@link NormalizedResourceOffer#calculateMinPercentageUsedBy(NormalizedResourceOffer)}.
* </p>
@@ -46,8 +46,7 @@ public class ObjectResourcesItem {
* Note that nodes are grouped into hosts, hosts into racks, and racks are grouped under the cluster.
*
* <p>
- * An example of this calculation is in
- * {@link NodeSorter#sortObjectResourcesCommon(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)}
+ * An example of this calculation is in {@link NodeSorter}
* where value is calculated by {@link ObjectResourcesSummary#getAvailableResourcesOverall()}
* using {@link NormalizedResourceOffer#calculateAveragePercentageUsedBy(NormalizedResourceOffer)}.
* </p>
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
index 7f892dd70..affd8e004 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorter.java
@@ -76,15 +76,6 @@ public class NodeSorter implements INodeSorter {
/**
* Initialize for the default implementation node sorting.
*
- * <p>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#GENERIC_RAS} sorting implemented in
- * {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)}</li>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#DEFAULT_RAS} sorting implemented in
- * {@link #sortObjectResourcesDefault(ObjectResourcesSummary, NodeSorter.ExistingScheduleFunc)}</li>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#COMMON} sorting implemented in
- * {@link #sortObjectResourcesCommon(ObjectResourcesSummary, ExecutorDetails, NodeSorter.ExistingScheduleFunc)}</li>
- * </p>
- *
* @param cluster for which nodes will be sorted.
* @param topologyDetails the topology to sort for.
* @param nodeSortType type of sorting to be applied to object resource collection {@link BaseResourceAwareStrategy.NodeSortType}.
@@ -169,14 +160,14 @@ public class NodeSorter implements INodeSorter {
* above will be ranked after racks that have more balanced resource availability and nodes or racks that have
* resources that are not requested will be ranked below . So we will be less likely to pick a rack that
* have a lot of one resource but a low amount of another and have a lot of resources that are not requested by the executor.
- * This is similar to logic used {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * This is similar to logic used in {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
* </li>
*
* <li>
* The tie between two nodes with same resource availability is broken by using the node with lower minimum
* percentage used. This comparison was used in {@link #sortObjectResourcesDefault(ObjectResourcesSummary, ExistingScheduleFunc)}
* but here it is made subservient to modified resource availbility used in
- * {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
*
* </li>
*
@@ -365,7 +356,7 @@ public class NodeSorter implements INodeSorter {
* <p>2) the subordinate/subservient resource availability percentage of a node in descending
* order We calculate the resource availability percentage by dividing the resource availability that have exhausted or little of one of
* the resources mentioned above will be ranked after on the node by the resource availability of the entire rack By doing this
- * calculation, nodes nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
+ * calculation, nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
* one resource but a low amount of another.
*
* @param availRasNodes a list of all the nodes we want to sort
diff --git a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
index a58c24d07..07a167223 100644
--- a/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
+++ b/storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/NodeSorterHostProximity.java
@@ -80,16 +80,6 @@ public class NodeSorterHostProximity implements INodeSorter {
/**
* Initialize for the default implementation node sorting.
- *
- * <p>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#GENERIC_RAS} sorting implemented in
- * {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, NodeSorterHostProximity.ExistingScheduleFunc)}</li>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#DEFAULT_RAS} sorting implemented in
- * {@link #sortObjectResourcesDefault(ObjectResourcesSummary, NodeSorterHostProximity.ExistingScheduleFunc)}</li>
- * <li>{@link BaseResourceAwareStrategy.NodeSortType#COMMON} sorting implemented in
- * {@link #sortObjectResourcesCommon(ObjectResourcesSummary, ExecutorDetails, NodeSorterHostProximity.ExistingScheduleFunc)}</li>
- * </p>
- *
* @param cluster for which nodes will be sorted.
* @param topologyDetails the topology to sort for.
* @param nodeSortType type of sorting to be applied to object resource collection {@link BaseResourceAwareStrategy.NodeSortType}.
@@ -179,14 +169,14 @@ public class NodeSorterHostProximity implements INodeSorter {
* above will be ranked after racks that have more balanced resource availability and nodes or racks that have
* resources that are not requested will be ranked below . So we will be less likely to pick a rack that
* have a lot of one resource but a low amount of another and have a lot of resources that are not requested by the executor.
- * This is similar to logic used {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * This is similar to logic used in {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
* </li>
*
* <li>
* The tie between two nodes with same resource availability is broken by using the node with lower minimum
* percentage used. This comparison was used in {@link #sortObjectResourcesDefault(ObjectResourcesSummary, ExistingScheduleFunc)}
* but here it is made subservient to modified resource availbility used in
- * {@link #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
+ * {@code #sortObjectResourcesGeneric(ObjectResourcesSummary, ExecutorDetails, ExistingScheduleFunc)}.
*
* </li>
*
@@ -384,7 +374,7 @@ public class NodeSorterHostProximity implements INodeSorter {
* <p>2) the subordinate/subservient resource availability percentage of a node in descending
* order We calculate the resource availability percentage by dividing the resource availability that have exhausted or little of one of
* the resources mentioned above will be ranked after on the node by the resource availability of the entire rack By doing this
- * calculation, nodes nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
+ * calculation, nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
* one resource but a low amount of another.
*
* @param availHosts a collection of all the hosts we want to sort
@@ -431,7 +421,7 @@ public class NodeSorterHostProximity implements INodeSorter {
* <p>2) the subordinate/subservient resource availability percentage of a node in descending
* order We calculate the resource availability percentage by dividing the resource availability that have exhausted or little of one of
* the resources mentioned above will be ranked after on the node by the resource availability of the entire rack By doing this
- * calculation, nodes nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
+ * calculation, nodes that have more balanced resource availability. So we will be less likely to pick a node that have a lot of
* one resource but a low amount of another.
*
* @param availRasNodes a list of all the nodes we want to sort
diff --git a/storm-server/src/main/java/org/apache/storm/utils/EnumUtil.java b/storm-server/src/main/java/org/apache/storm/utils/EnumUtil.java
index 0b1d723ab..33ff14983 100644
--- a/storm-server/src/main/java/org/apache/storm/utils/EnumUtil.java
+++ b/storm-server/src/main/java/org/apache/storm/utils/EnumUtil.java
@@ -26,8 +26,6 @@ public class EnumUtil {
* Create an Enum map with given lambda mapper.
* @param klass the Enum class
* @param mapper The mapper producing value with key (enum constant)
- * @param <T> An Enum class
- * @param <U> Mapped class
* @return An Enum map
*/
public static <T extends Enum<T>, U> EnumMap<T, U> toEnumMap(Class<T> klass, Function<? super T, ? extends U> mapper) {