mirror of https://github.com/apache/activemq.git
Fix some javadoc warnings releated to non-existing parameter names.
This commit is contained in:
Pascal Schumacher
parent
d474580a34
commit
67e06c82f7
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -116,7 +116,6 @@ public interface TopicMessageStore extends MessageStore {
|
|||
/**
|
||||
* The subscription metrics contained in this store
|
||||
*
|
||||
* @param subscriptionKey
|
||||
* @return
|
||||
*/
|
||||
MessageStoreSubscriptionStatistics getMessageStoreSubStatistics();
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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 <code>null</code>
|
||||
* @return not <code>null</code>
|
||||
* @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 <code>null</code>
|
||||
* @return not <code>null</code>
|
||||
* @throws Exception
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue