Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

eliminated all javadoc warnings; no API changes, with the exception of adding generics metadata to GatewayProxyFactoryBean (now 'implements FactoryBean<Object>').

Browse Source
This commit is contained in:
Chris Beams
2010-05-20 17:50:32 +00:00
parent cf6027e3b7
commit 233994116c
38 changed files with 453 additions and 499 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
org.springframework.integration/src/main/java/org/springframework/integration/aggregator/CorrelationStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -22,7 +22,7 @@ import org.springframework.integration.core.Message;
* Strategy for determining how messages shall be correlated. Implementations
* shall return the correlation key value associated with a particular message.
*
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public interface CorrelationStrategy {

2
org.springframework.integration/src/main/java/org/springframework/integration/aggregator/CorrelationStrategyAdapter.java
View File

@@ -25,7 +25,7 @@ import org.springframework.util.Assert;
/**
* {@link CorrelationStrategy} implementation that works as an adapter to another bean.
*
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public class CorrelationStrategyAdapter implements CorrelationStrategy {

4
org.springframework.integration/src/main/java/org/springframework/integration/aggregator/HeaderAttributeCorrelationStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -22,7 +22,7 @@ import org.springframework.integration.core.Message;
* Default implementation of {@link CorrelationStrategy}. Uses a header
* attribute to determine the correlation key value.
*
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public class HeaderAttributeCorrelationStrategy implements CorrelationStrategy {

4
org.springframework.integration/src/main/java/org/springframework/integration/annotation/CorrelationStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* Indicates that a given method is capable of determining the correlation key
* of a message sent as parameter.
*
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
@Retention (RetentionPolicy.RUNTIME)
@Target (ElementType.METHOD)

2
org.springframework.integration/src/main/java/org/springframework/integration/aop/ExpressionSource.java
View File

@@ -63,7 +63,7 @@ interface ExpressionSource {
/**
* Returns the variable name to use in the evaluation context for the Map
* of arguments. The keys in this map will be determined by the result of
* the {@link #getArgumentNames(Method)} method.
* the {@link #getArgumentVariableNames(Method)} method.
*/
String getArgumentMapVariableName(Method method);

11
org.springframework.integration/src/main/java/org/springframework/integration/channel/PriorityChannel.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -20,6 +20,7 @@ import java.util.Comparator;
import java.util.concurrent.PriorityBlockingQueue;
import org.springframework.integration.core.Message;
import org.springframework.integration.core.MessageHeaders;
import org.springframework.integration.core.MessagePriority;
import org.springframework.integration.util.UpperBound;
@@ -39,7 +40,7 @@ public class PriorityChannel extends QueueChannel {
* is a non-positive value, the queue will be unbounded. Message priority
* will be determined by the provided {@link Comparator}. If the comparator
* is <code>null</code>, the priority will be based upon the value of
* {@link MessageHeader#getPriority()}.
* {@link MessageHeaders#getPriority()}.
*/
public PriorityChannel(int capacity, Comparator<Message<?>> comparator) {
super(new PriorityBlockingQueue<Message<?>>(11,
@@ -49,7 +50,7 @@ public class PriorityChannel extends QueueChannel {
/**
* Create a channel with the specified queue capacity. Message priority
* will be based upon the value of {@link MessageHeader#getPriority()}.
* will be based upon the value of {@link MessageHeaders#getPriority()}.
*/
public PriorityChannel(int capacity) {
this(capacity, null);
@@ -59,7 +60,7 @@ public class PriorityChannel extends QueueChannel {
* Create a channel with an unbounded queue. Message priority will be
* determined by the provided {@link Comparator}. If the comparator
* is <code>null</code>, the priority will be based upon the value of
* {@link MessageHeader#getPriority()}.
* {@link MessageHeaders#getPriority()}.
*/
public PriorityChannel(Comparator<Message<?>> comparator) {
this(0, comparator);
@@ -67,7 +68,7 @@ public class PriorityChannel extends QueueChannel {
/**
* Create a channel with an unbounded queue. Message priority will be
* based on the value of {@link MessageHeader#getPriority()}.
* based on the value of {@link MessageHeaders#getPriority()}.
*/
public PriorityChannel() {
this(0, null);

6
org.springframework.integration/src/main/java/org/springframework/integration/channel/interceptor/WireTap.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -69,9 +69,7 @@ public class WireTap extends ChannelInterceptorAdapter implements Lifecycle {
/**
* Specify the timeout value for sending to the intercepting target. Note
* that this value will only apply if the target is a {@link BlockingTarget}.
* The default value is 0.
* Specify the timeout value for sending to the intercepting target.
*
* @param timeout the timeout in milliseconds
*/

40
org.springframework.integration/src/main/java/org/springframework/integration/config/xml/IntegrationNamespaceUtils.java
View File

@@ -18,12 +18,9 @@ package org.springframework.integration.config.xml;
import java.util.List;
import org.w3c.dom.Element;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.parsing.BeanComponentDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate;
@@ -33,6 +30,8 @@ import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;
/**
* Shared utility methods for integration namespace parsers.
*
@@ -51,11 +50,11 @@ public abstract class IntegrationNamespaceUtils {
/**
* Populates the specified bean definition property with the value
* of the attribute whose name is provided if that attribute is
* defined in the given element.
* Configures the provided bean definition builder with a property
* value corresponding to the attribute whose name is provided if
* that attribute is defined in the given element.
*
* @param beanDefinition the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be
* used to populate the property
@@ -70,9 +69,9 @@ public abstract class IntegrationNamespaceUtils {
}
/**
* Populates the bean definition property corresponding to the specified
* attributeName with the value of that attribute if it is defined in the
* given element.
* Configures the provided bean definition builder with a property
* value corresponding to the attribute whose name is provided if
* that attribute is defined in the given element.
*
* <p>The property name will be the camel-case equivalent of the lower
* case hyphen separated attribute (e.g. the "foo-bar" attribute would
@@ -80,7 +79,7 @@ public abstract class IntegrationNamespaceUtils {
*
* @see Conventions#attributeNameToPropertyName(String)
*
* @param beanDefinition - the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element - the XML element where the attribute should be defined
* @param attributeName - the name of the attribute whose value will be set
* on the property
@@ -92,12 +91,12 @@ public abstract class IntegrationNamespaceUtils {
}
/**
* Populates the specified bean definition property with the reference
* to a bean. The bean reference is identified by the value from the
* attribute whose name is provided if that attribute is defined in
* the given element.
* Configures the provided bean definition builder with a property
* reference to a bean. The bean reference is identified by the value
* from the attribute whose name is provided if that attribute is
* defined in the given element.
*
* @param beanDefinition the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be
* used as a bean reference to populate the property
@@ -112,9 +111,10 @@ public abstract class IntegrationNamespaceUtils {
}
/**
* Populates the bean definition property corresponding to the specified
* attributeName with the reference to a bean identified by the value of
* that attribute if the attribute is defined in the given element.
* Configures the provided bean definition builder with a property
* reference to a bean. The bean reference is identified by the value
* from the attribute whose name is provided if that attribute is
* defined in the given element.
*
* <p>The property name will be the camel-case equivalent of the lower
* case hyphen separated attribute (e.g. the "foo-bar" attribute would
@@ -122,7 +122,7 @@ public abstract class IntegrationNamespaceUtils {
*
* @see Conventions#attributeNameToPropertyName(String)
*
* @param beanDefinition - the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element - the XML element where the attribute should be defined
* @param attributeName - the name of the attribute whose value will be
* used as a bean reference to populate the property

8
org.springframework.integration/src/main/java/org/springframework/integration/core/MessagePriority.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -16,12 +16,14 @@
package org.springframework.integration.core;
import org.springframework.integration.message.MessageBuilder;
/**
* An enumeration of the possible values for a message's priority.
*
* @author Mark Fisher
* @see MessageHeader#getPriority()
* @see MessageHeader#setPriority(MessagePriority)
* @see MessageHeaders#getPriority()
* @see MessageBuilder#setPriority(MessagePriority)
*/
public enum MessagePriority {

6
org.springframework.integration/src/main/java/org/springframework/integration/gateway/GatewayProxyFactoryBean.java
View File

@@ -47,7 +47,7 @@ import org.springframework.util.StringUtils;
* @author Mark Fisher
* @author Oleg Zhurakousky
*/
public class GatewayProxyFactoryBean extends AbstractEndpoint implements FactoryBean, MethodInterceptor, BeanClassLoaderAware {
public class GatewayProxyFactoryBean extends AbstractEndpoint implements FactoryBean<Object>, MethodInterceptor, BeanClassLoaderAware {
private volatile Class<?> serviceInterface;
@@ -102,7 +102,7 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Factory
/**
* Set the default request channel.
*
* @param defaulRequestChannel the channel to which request messages will
* @param defaultRequestChannel the channel to which request messages will
* be sent if no request channel has been configured with an annotation
*/
public void setDefaultRequestChannel(MessageChannel defaultRequestChannel) {
@@ -114,7 +114,7 @@ public class GatewayProxyFactoryBean extends AbstractEndpoint implements Factory
* and no reply channel is configured with annotations, an anonymous,
* temporary channel will be used for handling replies.
*
* @param replyChannel the channel from which reply messages will be
* @param defaultReplyChannel the channel from which reply messages will be
* received if no reply channel has been configured with an annotation
*/
public void setDefaultReplyChannel(MessageChannel defaultReplyChannel) {

6
org.springframework.integration/src/main/java/org/springframework/integration/handler/ArgumentArrayMessageMapper.java
View File

@@ -62,8 +62,8 @@ import org.springframework.util.StringUtils;
* will be passed. These parameters can be labeled explicitly with the
* {@link Headers @Headers} annotation, or matched implicitly by using a non-
* ambiguous method signature. There can be as many parameters annotated with
* @Header as necessary, but typically there should be only one parameter
* expecting multiple headers (with or without the @Headers annotation).
* {@code @Header} as necessary, but typically there should be only one parameter
* expecting multiple headers (with or without the {@code @Headers} annotation).
* <p/>
* If a Map or Properties object is expected, and the payload is not itself
* assignable to that type or capable of being converted to that type, then
@@ -73,7 +73,7 @@ import org.springframework.util.StringUtils;
* parameters are legal. If, however, the actual payload type is a Map or
* Properties instance, then this ambiguity cannot be resolved. For that
* reason, it is highly recommended to use the explicit
* {@link Headers @Headers} annotation whenever possible.
* {@code Headers @Headers} annotation whenever possible.
* <p/>
* Some examples of legal method signatures:<br/>
* <tt>public void dealWith(Object payload);</tt><br/>

13
org.springframework.integration/src/main/java/org/springframework/integration/message/GenericMessage.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -38,8 +38,7 @@ public class GenericMessage<T> implements Message<T>, Serializable {
/**
* Create a new message with the given payload. The id will be generated by
* the default {@link IdGenerator} strategy.
* Create a new message with the given payload.
*
* @param payload the message payload
*/
@@ -48,12 +47,12 @@ public class GenericMessage<T> implements Message<T>, Serializable {
}
/**
* Create a new message with the given payload. The id will be generated by
* the default {@link IdGenerator} strategy. The headers will be populated
* with the provided header values.
* Create a new message with the given payload. The provided map
* will be used to populate the message headers
*
* @param payload the message payload
* @param headers message headers
* @see MessageHeaders
*/
public GenericMessage(T payload, Map<String, Object> headers) {
Assert.notNull(payload, "payload must not be null");
@@ -88,7 +87,7 @@ public class GenericMessage<T> implements Message<T>, Serializable {
if (this == obj) {
return true;
}
if (obj != null && obj instanceof GenericMessage) {
if (obj != null && obj instanceof GenericMessage<?>) {
GenericMessage<?> other = (GenericMessage<?>) obj;
if (!this.headers.getId().equals(other.headers.getId())) {
return false;

4
org.springframework.integration/src/main/java/org/springframework/integration/message/MessageBuilder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -62,7 +62,7 @@ public final class MessageBuilder<T> {
* all of the headers copied from the provided message. The payload of the
* provided Message will also be used as the payload for the new message.
*
* @param messageToCopy the Message from which the payload and all headers
* @param message the Message from which the payload and all headers
* will be copied
*/
public static <T> MessageBuilder<T> fromMessage(Message<T> message) {

4
org.springframework.integration/src/main/java/org/springframework/integration/router/HeaderValueRouter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -28,7 +28,7 @@ import org.springframework.util.StringUtils;
*
* @author Oleg Zhurakousky
* @author Mark Fisher
* @Since 1.0.3
* @since 1.0.3
*/
public class HeaderValueRouter extends AbstractChannelNameResolvingMessageRouter {

6
org.springframework.integration/src/main/java/org/springframework/integration/store/MessageGroupStore.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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
@@ -12,8 +12,6 @@
*/
package org.springframework.integration.store;
import java.util.Collection;
import org.springframework.integration.core.Message;
/**
@@ -28,7 +26,7 @@ public interface MessageGroupStore {
/**
* Return all Messages currently in the MessageStore that were stored using
* {@link #addMessageToGroup(Object, Collection)} with this correlation id.
* {@link #addMessageToGroup(Object, Message)} with this correlation id.
*
* @return a group of messages, empty if none exists for this key
*/

2
org.springframework.integration/src/main/java/org/springframework/integration/transformer/MessageTransformingHandler.java
View File

@@ -17,8 +17,10 @@
package org.springframework.integration.transformer;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.integration.core.Message;
import org.springframework.integration.handler.AbstractReplyProducingMessageHandler;
import org.springframework.integration.message.MessageHandler;
import org.springframework.util.Assert;
/**

4
org.springframework.integration/src/test/java/org/springframework/integration/aggregator/HeaderAttributeCorrelationStrategyTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -24,7 +24,7 @@ import org.springframework.integration.message.MessageBuilder;
import org.junit.Test;
/**
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public class HeaderAttributeCorrelationStrategyTests {

4
org.springframework.integration/src/test/java/org/springframework/integration/config/CorrelationStrategyInvalidConfigurationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -22,7 +22,7 @@ import org.springframework.beans.factory.BeanCreationException;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public class CorrelationStrategyInvalidConfigurationTests {

6
org.springframework.integration/src/test/java/org/springframework/integration/config/TestCorrelationStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2009 the original author or authors.
* Copyright 2002-2010 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.
@@ -20,12 +20,12 @@ import org.springframework.integration.aggregator.CorrelationStrategy;
import org.springframework.integration.core.Message;
/**
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
public class TestCorrelationStrategy implements CorrelationStrategy {
public Object getCorrelationKey(Message<?> message) {
throw new UnsupportedOperationException("for configuration test only");
}
}

4
org.springframework.integration/src/test/java/org/springframework/integration/config/annotation/TestAnnotatedEndpointWithCorrelationStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2010 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.
@@ -24,7 +24,7 @@ import org.springframework.integration.annotation.ReleaseStrategy;
import org.springframework.integration.annotation.CorrelationStrategy;
/**
* @author: Marius Bogoevici
* @author Marius Bogoevici
*/
@MessageEndpoint("endpointWithCorrelationStrategy")
public class TestAnnotatedEndpointWithCorrelationStrategy {