INT-2238 removing warnings in JavaDoc

This commit is contained in:
Mark Fisher
2011-11-22 21:38:04 -05:00
parent b1680a0cdf
commit 6c1454ae3d
16 changed files with 47 additions and 58 deletions

View File

@@ -10,6 +10,7 @@
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.springframework.integration.aggregator;
import java.util.Iterator;
@@ -18,6 +19,7 @@ import java.util.concurrent.ConcurrentMap;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.integration.Message;
import org.springframework.integration.core.MessageSource;
import org.springframework.integration.handler.AbstractMessageHandler;
@@ -32,7 +34,7 @@ import org.springframework.integration.store.SimpleMessageStore;
* {@link org.springframework.integration.aggregator.ReleaseStrategy#canRelease(org.springframework.integration.store.MessageGroup) canRelease(..)}
* method).
* <p/>
* This class differs from CorrelatingMessageHandler in that it completely decouples the receiver and the sender. It can
* This class differs from AbstractCorrelatingMessageHandler in that it completely decouples the receiver and the sender. It can
* be applied in scenarios where completion of a message group is not well defined but only a certain amount of messages
* for any given correlation key may be processed at a time.
* <p/>
@@ -42,17 +44,21 @@ import org.springframework.integration.store.SimpleMessageStore;
* @author Iwein Fuld
* @author Oleg Zhurakousky
*
* @see CorrelatingMessageHandler
* @see AbstractCorrelatingMessageHandler
*/
public class CorrelatingMessageBarrier extends AbstractMessageHandler implements MessageSource<Object> {
private static final Log log = LogFactory.getLog(CorrelatingMessageBarrier.class);
private CorrelationStrategy correlationStrategy;
private ReleaseStrategy releaseStrategy;
private volatile CorrelationStrategy correlationStrategy;
private volatile ReleaseStrategy releaseStrategy;
private final ConcurrentMap<Object, Object> correlationLocks = new ConcurrentHashMap<Object, Object>();
private final MessageGroupStore store;
public CorrelatingMessageBarrier(MessageGroupStore store) {
this.store = store;
}
@@ -61,6 +67,7 @@ public class CorrelatingMessageBarrier extends AbstractMessageHandler implements
this(new SimpleMessageStore(0));
}
/**
* Set the CorrelationStrategy to be used to determine the correlation key for incoming messages
*/
@@ -127,4 +134,5 @@ public class CorrelatingMessageBarrier extends AbstractMessageHandler implements
correlationLocks.remove(key);
store.removeMessageGroup(key);
}
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2010 the original author or authors.
* Copyright 2002-2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
@@ -19,7 +19,7 @@ import org.springframework.integration.store.MessageGroup;
* A processor for <i>correlated</i> groups of messages.
*
* @author Iwein Fuld
* @see org.springframework.integration.aggregator.CorrelatingMessageHandler
* @see org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler
*/
public interface MessageGroupProcessor {

View File

@@ -76,7 +76,7 @@ public abstract class AbstractHeaderMapper<T> implements RequestReplyHeaderMappe
* The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.
* <p>
* This will match the header name directly or, for non-standard headers, it will match
* the header name prefixed with the value specified by {@link #setInboundPrefix(String)}.
* the header name prefixed with the value, if specified, by {@link #setUserDefinedHeaderPrefix(String)}.
*/
public void setRequestHeaderNames(String[] requestHeaderNames) {
Assert.notNull(requestHeaderNames, "'requestHeaderNames' must not be null");
@@ -88,7 +88,7 @@ public abstract class AbstractHeaderMapper<T> implements RequestReplyHeaderMappe
* FROM a Spring Integration Message's headers.
* The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.
* <p>
* Any non-standard headers will be prefixed with the value specified by {@link #setOutboundPrefix(String)}.
* Any non-standard headers will be prefixed with the value specified by {@link #setUserDefinedHeaderPrefix(String)}.
*/
public void setReplyHeaderNames(String[] replyHeaderNames) {
Assert.notNull(replyHeaderNames, "'replyHeaderNames' must not be null");

View File

@@ -88,7 +88,7 @@ public class ContentEnricher extends AbstractReplyProducingMessageHandler implem
/**
* Sets the content enricher's request channel. If specified, then an internal
* {@link Gateway} will be initialized. Setting a request channel is optional.
* Gateway will be initialized. Setting a request channel is optional.
* Not setting a request channel is useful in situations where
* message payloads shall be enriched with static values only.
*/