From 67e06c82f740b5f2a28ff9c4d0e3231334349298 Mon Sep 17 00:00:00 2001 From: Pascal Schumacher Date: Sun, 17 May 2020 11:38:05 +0200 Subject: [PATCH] Fix some javadoc warnings releated to non-existing parameter names. --- .../amqp/protocol/AmqpTransactionCoordinator.java | 2 +- .../src/main/java/org/apache/activemq/broker/Locker.java | 2 +- .../org/apache/activemq/broker/scheduler/JobListener.java | 2 +- .../activemq/plugin/ForcePersistencyModeBroker.java | 2 +- .../java/org/apache/activemq/store/TopicMessageStore.java | 1 - .../org/apache/activemq/filter/ConstantExpression.java | 2 +- .../apache/activemq/filter/function/FilterFunction.java | 8 ++++---- .../apache/activemq/filter/function/makeListFunction.java | 2 +- .../activemq/filter/function/regexMatchFunction.java | 2 +- .../java/org/apache/activemq/wireformat/WireFormat.java | 2 +- .../apache/activemq/store/kahadb/AbstractKahaDBStore.java | 2 +- .../activemq/store/kahadb/scheduler/JobLocation.java | 2 +- .../store/kahadb/scheduler/JobSchedulerStoreImpl.java | 2 +- .../kahadb/scheduler/legacy/LegacyStoreReplayer.java | 1 - .../apache/activemq/transport/mqtt/MQTTWireFormat.java | 2 +- .../plugin/java/JavaRuntimeConfigurationBroker.java | 2 +- .../main/java/org/apache/activemq/web/BrokerFacade.java | 4 +--- 17 files changed, 18 insertions(+), 22 deletions(-) diff --git a/activemq-amqp/src/main/java/org/apache/activemq/transport/amqp/protocol/AmqpTransactionCoordinator.java b/activemq-amqp/src/main/java/org/apache/activemq/transport/amqp/protocol/AmqpTransactionCoordinator.java index 95cd5e372a..7a33c9da9a 100644 --- a/activemq-amqp/src/main/java/org/apache/activemq/transport/amqp/protocol/AmqpTransactionCoordinator.java +++ b/activemq-amqp/src/main/java/org/apache/activemq/transport/amqp/protocol/AmqpTransactionCoordinator.java @@ -63,7 +63,7 @@ public class AmqpTransactionCoordinator extends AmqpAbstractReceiver { * * @param session * the AmqpSession under which the coordinator was created. - * @param receiver + * @param endpoint * the AMQP receiver link endpoint for this coordinator. */ public AmqpTransactionCoordinator(AmqpSession session, Receiver endpoint) { diff --git a/activemq-broker/src/main/java/org/apache/activemq/broker/Locker.java b/activemq-broker/src/main/java/org/apache/activemq/broker/Locker.java index f6bc4b68cb..c61898f141 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/broker/Locker.java +++ b/activemq-broker/src/main/java/org/apache/activemq/broker/Locker.java @@ -49,7 +49,7 @@ public interface Locker extends Service { * Specify whether to fail immediately if the lock is already held. When set, the CustomLock must throw an * IOException immediately upon detecting the lock is already held. * - * @param failIfLocked: true => fail immediately if the lock is held; false => block until the lock can be obtained + * @param failIfLocked true => fail immediately if the lock is held; false => block until the lock can be obtained * (default). */ public void setFailIfLocked(boolean failIfLocked); diff --git a/activemq-broker/src/main/java/org/apache/activemq/broker/scheduler/JobListener.java b/activemq-broker/src/main/java/org/apache/activemq/broker/scheduler/JobListener.java index a453595f74..fae4e36575 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/broker/scheduler/JobListener.java +++ b/activemq-broker/src/main/java/org/apache/activemq/broker/scheduler/JobListener.java @@ -28,7 +28,7 @@ public interface JobListener { * A Job that has been scheduled is now ready to be fired. The Job is passed * in its raw byte form and must be un-marshaled before being delivered. * - * @param jobId + * @param id * The unique Job Id of the Job that is ready to fire. * @param job * The job that is now ready, delivered in byte form. diff --git a/activemq-broker/src/main/java/org/apache/activemq/plugin/ForcePersistencyModeBroker.java b/activemq-broker/src/main/java/org/apache/activemq/plugin/ForcePersistencyModeBroker.java index 249ed00beb..4897f68c74 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/plugin/ForcePersistencyModeBroker.java +++ b/activemq-broker/src/main/java/org/apache/activemq/plugin/ForcePersistencyModeBroker.java @@ -44,7 +44,7 @@ public class ForcePersistencyModeBroker extends BrokerFilter{ } /** - * @param persistenceFlag the persistenceFlag to set + * @param mode the persistenceFlag to set */ public void setPersistenceFlag(boolean mode) { this.persistence = mode; diff --git a/activemq-broker/src/main/java/org/apache/activemq/store/TopicMessageStore.java b/activemq-broker/src/main/java/org/apache/activemq/store/TopicMessageStore.java index 1d126c2bc3..95d5b72ed5 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/store/TopicMessageStore.java +++ b/activemq-broker/src/main/java/org/apache/activemq/store/TopicMessageStore.java @@ -116,7 +116,6 @@ public interface TopicMessageStore extends MessageStore { /** * The subscription metrics contained in this store * - * @param subscriptionKey * @return */ MessageStoreSubscriptionStatistics getMessageStoreSubStatistics(); diff --git a/activemq-client/src/main/java/org/apache/activemq/filter/ConstantExpression.java b/activemq-client/src/main/java/org/apache/activemq/filter/ConstantExpression.java index 53e4a13006..d362300d3a 100644 --- a/activemq-client/src/main/java/org/apache/activemq/filter/ConstantExpression.java +++ b/activemq-client/src/main/java/org/apache/activemq/filter/ConstantExpression.java @@ -144,7 +144,7 @@ public class ConstantExpression implements Expression { * Encodes the value of string so that it looks like it would look like when * it was provided in a selector. * - * @param string + * @param s * @return */ public static String encodeString(String s) { diff --git a/activemq-client/src/main/java/org/apache/activemq/filter/function/FilterFunction.java b/activemq-client/src/main/java/org/apache/activemq/filter/function/FilterFunction.java index f8dec464b7..c7f81fbe5f 100644 --- a/activemq-client/src/main/java/org/apache/activemq/filter/function/FilterFunction.java +++ b/activemq-client/src/main/java/org/apache/activemq/filter/function/FilterFunction.java @@ -29,7 +29,7 @@ public interface FilterFunction { * to clients at the time invalid selectors are initially specified, rather than waiting until the selector is * applied to a message. * - * @param FunctionCallExpression expr - the full expression of the function call, as used. + * @param expr - the full expression of the function call, as used. * @return true - if the function call is valid; false - otherwise. */ public boolean isValid(FunctionCallExpression expr); @@ -40,7 +40,7 @@ public interface FilterFunction { * been parsed. This allows functions with variable return types to function as boolean expressions in * selectors without sacrificing parse-time checking. * - * @param FunctionCallExpression expr - the full expression of the function call, as used. + * @param expr - the full expression of the function call, as used. * @return true - if the function returns a boolean value for its use in the given expression; * false - otherwise. */ @@ -51,8 +51,8 @@ public interface FilterFunction { * Evaluate the function call in the given context. The arguments must be evaluated, as-needed, by the * function. Note that boolean expressions must return Boolean objects. * - * @param FunctionCallExpression expr - the full expression of the function call, as used. - * @param MessageEvaluationContext message - the context within which to evaluate the call. + * @param expr - the full expression of the function call, as used. + * @param message - the context within which to evaluate the call. */ public Object evaluate(FunctionCallExpression expr, MessageEvaluationContext message) throws javax.jms.JMSException; diff --git a/activemq-client/src/main/java/org/apache/activemq/filter/function/makeListFunction.java b/activemq-client/src/main/java/org/apache/activemq/filter/function/makeListFunction.java index 7fedd7bdab..974cb8f15d 100644 --- a/activemq-client/src/main/java/org/apache/activemq/filter/function/makeListFunction.java +++ b/activemq-client/src/main/java/org/apache/activemq/filter/function/makeListFunction.java @@ -58,7 +58,7 @@ public class makeListFunction implements FilterFunction { * a list containing the evaluated results of its argument expressions. * * @param expr - the expression consisting of a call to this function. - * @param message_ctx - the context in which the call is being evaluated. + * @param message - the context in which the call is being evaluated. * @return java.util.List - the result of the evaluation. */ diff --git a/activemq-client/src/main/java/org/apache/activemq/filter/function/regexMatchFunction.java b/activemq-client/src/main/java/org/apache/activemq/filter/function/regexMatchFunction.java index c9b32c9fdb..757d776140 100644 --- a/activemq-client/src/main/java/org/apache/activemq/filter/function/regexMatchFunction.java +++ b/activemq-client/src/main/java/org/apache/activemq/filter/function/regexMatchFunction.java @@ -68,7 +68,7 @@ public class regexMatchFunction implements FilterFunction { * an indication of whether the second argument matches the regular expression in the first argument. * * @param expr - the expression consisting of a call to this function. - * @param message_ctx - the context in which the call is being evaluated. + * @param message - the context in which the call is being evaluated. * @return true - if the value matches the regular expression; false - otherwise. */ diff --git a/activemq-client/src/main/java/org/apache/activemq/wireformat/WireFormat.java b/activemq-client/src/main/java/org/apache/activemq/wireformat/WireFormat.java index c869e33e31..c2e7329fc7 100644 --- a/activemq-client/src/main/java/org/apache/activemq/wireformat/WireFormat.java +++ b/activemq-client/src/main/java/org/apache/activemq/wireformat/WireFormat.java @@ -52,7 +52,7 @@ public interface WireFormat { Object unmarshal(DataInput in) throws IOException; /** - * @param the version of the wire format + * @param version the version of the wire format */ void setVersion(int version); diff --git a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/AbstractKahaDBStore.java b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/AbstractKahaDBStore.java index 70be2fbd9e..58cf907afd 100644 --- a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/AbstractKahaDBStore.java +++ b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/AbstractKahaDBStore.java @@ -609,7 +609,7 @@ public abstract class AbstractKahaDBStore extends LockableServiceSupport { /** * Creates a new ByteSequence that represents the marshaled form of the given Journal Command. * - * @param command + * @param data * The Journal Command that should be marshaled to bytes for writing. * * @return the byte representation of the given journal command. diff --git a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobLocation.java b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobLocation.java index cb66145692..51efd27539 100644 --- a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobLocation.java +++ b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobLocation.java @@ -234,7 +234,7 @@ class JobLocation { * zero and increment this value each time a scheduled message is dispatched to its * target destination and the job is rescheduled for another cycle. * - * @param executionCount + * @param rescheduledCount * the new execution count to assign the JobLocation. */ public void setRescheduledCount(int rescheduledCount) { diff --git a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobSchedulerStoreImpl.java b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobSchedulerStoreImpl.java index 7720159b38..de9fe0c404 100644 --- a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobSchedulerStoreImpl.java +++ b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/JobSchedulerStoreImpl.java @@ -649,7 +649,7 @@ public class JobSchedulerStoreImpl extends AbstractKahaDBStore implements JobSch * Called during index recovery to rebuild the index from the last known good location. For * entries that occur before the last known good position we just ignore then and move on. * - * @param command + * @param data * the command read from the Journal which should be used to update the index. * @param location * the location in the index where the command was read. diff --git a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/legacy/LegacyStoreReplayer.java b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/legacy/LegacyStoreReplayer.java index 92563f4467..0b437d609f 100644 --- a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/legacy/LegacyStoreReplayer.java +++ b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/scheduler/legacy/LegacyStoreReplayer.java @@ -40,7 +40,6 @@ public class LegacyStoreReplayer { /** * Creates a new Legacy Store Replayer with the given target store - * @param targetStore * @param directory */ public LegacyStoreReplayer(File directory) { diff --git a/activemq-mqtt/src/main/java/org/apache/activemq/transport/mqtt/MQTTWireFormat.java b/activemq-mqtt/src/main/java/org/apache/activemq/transport/mqtt/MQTTWireFormat.java index 2182f67711..382247f018 100644 --- a/activemq-mqtt/src/main/java/org/apache/activemq/transport/mqtt/MQTTWireFormat.java +++ b/activemq-mqtt/src/main/java/org/apache/activemq/transport/mqtt/MQTTWireFormat.java @@ -113,7 +113,7 @@ public class MQTTWireFormat implements WireFormat { } /** - * @param the version of the wire format + * @param version the version of the wire format */ @Override public void setVersion(int version) { diff --git a/activemq-runtime-config/src/main/java/org/apache/activemq/plugin/java/JavaRuntimeConfigurationBroker.java b/activemq-runtime-config/src/main/java/org/apache/activemq/plugin/java/JavaRuntimeConfigurationBroker.java index 23faeecbd0..1448501baf 100644 --- a/activemq-runtime-config/src/main/java/org/apache/activemq/plugin/java/JavaRuntimeConfigurationBroker.java +++ b/activemq-runtime-config/src/main/java/org/apache/activemq/plugin/java/JavaRuntimeConfigurationBroker.java @@ -175,7 +175,7 @@ public class JavaRuntimeConfigurationBroker extends AbstractRuntimeConfiguration * This allows the ability to limit which properties are applied to existing destinations. * * @param existing - * @param createIfAbsent + * @param createOrReplace * @param includedProperties - optional list of properties to apply retrospectively */ public void modifyPolicyEntry(PolicyEntry existing, boolean createOrReplace, diff --git a/activemq-web/src/main/java/org/apache/activemq/web/BrokerFacade.java b/activemq-web/src/main/java/org/apache/activemq/web/BrokerFacade.java index 31ef5185cf..720ebcbb16 100644 --- a/activemq-web/src/main/java/org/apache/activemq/web/BrokerFacade.java +++ b/activemq-web/src/main/java/org/apache/activemq/web/BrokerFacade.java @@ -97,7 +97,7 @@ public interface BrokerFacade { /** * All active non-durable subscribers to a topic. * - * @param queueName + * @param topicName * the name of the topic, not null * @return not null * @throws Exception @@ -108,8 +108,6 @@ public interface BrokerFacade { /** * All active non-durable subscribers to a topic. * - * @param queueName - * the name of the topic, not null * @return not null * @throws Exception */