Consistent javadoc param declarations for type variables
This commit is contained in:
parent
22670b7fad
commit
d23893fd25
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -28,21 +28,21 @@ import org.springframework.cache.interceptor.CacheResolver;
|
||||||
* <p>A cache operation can be statically cached as it does not contain
|
* <p>A cache operation can be statically cached as it does not contain
|
||||||
* any runtime operation of a specific cache invocation.
|
* any runtime operation of a specific cache invocation.
|
||||||
*
|
*
|
||||||
* @param <A> the type of the JSR-107 annotation
|
|
||||||
* @author Stephane Nicoll
|
* @author Stephane Nicoll
|
||||||
* @since 4.1
|
* @since 4.1
|
||||||
|
* @param <A> the type of the JSR-107 annotation
|
||||||
*/
|
*/
|
||||||
public interface JCacheOperation<A extends Annotation> extends BasicOperation, CacheMethodDetails<A> {
|
public interface JCacheOperation<A extends Annotation> extends BasicOperation, CacheMethodDetails<A> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the {@link CacheResolver} instance to use to resolve the cache to
|
* Return the {@link CacheResolver} instance to use to resolve the cache
|
||||||
* use for this operation.
|
* to use for this operation.
|
||||||
*/
|
*/
|
||||||
CacheResolver getCacheResolver();
|
CacheResolver getCacheResolver();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the {@link CacheInvocationParameter} instances based on the specified
|
* Return the {@link CacheInvocationParameter} instances based on the
|
||||||
* method arguments.
|
* specified method arguments.
|
||||||
* <p>The method arguments must match the signature of the related method invocation
|
* <p>The method arguments must match the signature of the related method invocation
|
||||||
* @param values the parameters value for a particular invocation
|
* @param values the parameters value for a particular invocation
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2012 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -20,25 +20,26 @@ import org.springframework.util.Assert;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An {@link ApplicationEvent} that carries an arbitrary payload.
|
* An {@link ApplicationEvent} that carries an arbitrary payload.
|
||||||
* <p>
|
|
||||||
* Mainly intended for internal use within the framework.
|
|
||||||
*
|
*
|
||||||
* @param <T> the payload type of the event
|
* <p>Mainly intended for internal use within the framework.
|
||||||
|
*
|
||||||
* @author Stephane Nicoll
|
* @author Stephane Nicoll
|
||||||
* @since 4.2
|
* @since 4.2
|
||||||
|
* @param <T> the payload type of the event
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("serial")
|
@SuppressWarnings("serial")
|
||||||
public class PayloadApplicationEvent<T>
|
public class PayloadApplicationEvent<T> extends ApplicationEvent {
|
||||||
extends ApplicationEvent {
|
|
||||||
|
|
||||||
private final T payload;
|
private final T payload;
|
||||||
|
|
||||||
|
|
||||||
public PayloadApplicationEvent(Object source, T payload) {
|
public PayloadApplicationEvent(Object source, T payload) {
|
||||||
super(source);
|
super(source);
|
||||||
Assert.notNull(payload, "Payload must not be null");
|
Assert.notNull(payload, "Payload must not be null");
|
||||||
this.payload = payload;
|
this.payload = payload;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the payload of the event.
|
* Return the payload of the event.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -28,9 +28,9 @@ import org.springframework.util.Assert;
|
||||||
* based on an {@link AdviceMode} value from an annotation (such as the {@code @Enable*}
|
* based on an {@link AdviceMode} value from an annotation (such as the {@code @Enable*}
|
||||||
* annotations).
|
* annotations).
|
||||||
*
|
*
|
||||||
* @param <A> Annotation containing {@linkplain #getAdviceModeAttributeName() AdviceMode attribute}
|
|
||||||
* @author Chris Beams
|
* @author Chris Beams
|
||||||
* @since 3.1
|
* @since 3.1
|
||||||
|
* @param <A> annotation containing {@linkplain #getAdviceModeAttributeName() AdviceMode attribute}
|
||||||
*/
|
*/
|
||||||
public abstract class AdviceModeImportSelector<A extends Annotation> implements ImportSelector {
|
public abstract class AdviceModeImportSelector<A extends Annotation> implements ImportSelector {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2012 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -24,8 +24,8 @@ package org.springframework.core.convert.converter;
|
||||||
* @author Keith Donald
|
* @author Keith Donald
|
||||||
* @since 3.0
|
* @since 3.0
|
||||||
* @see ConditionalConverter
|
* @see ConditionalConverter
|
||||||
* @param <S> The source type converters created by this factory can convert from
|
* @param <S> the source type converters created by this factory can convert from
|
||||||
* @param <R> The target range (or base) type converters created by this factory can convert to;
|
* @param <R> the target range (or base) type converters created by this factory can convert to;
|
||||||
* for example {@link Number} for a set of number subtypes.
|
* for example {@link Number} for a set of number subtypes.
|
||||||
*/
|
*/
|
||||||
public interface ConverterFactory<S, R> {
|
public interface ConverterFactory<S, R> {
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2012 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -29,9 +29,9 @@ import org.springframework.util.comparator.ComparableComparator;
|
||||||
* {@code Comparator}.
|
* {@code Comparator}.
|
||||||
*
|
*
|
||||||
* @author Phillip Webb
|
* @author Phillip Webb
|
||||||
|
* @since 3.2
|
||||||
* @param <S> the source type
|
* @param <S> the source type
|
||||||
* @param <T> the target type
|
* @param <T> the target type
|
||||||
* @since 3.2
|
|
||||||
*/
|
*/
|
||||||
public class ConvertingComparator<S, T> implements Comparator<S> {
|
public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
|
|
||||||
|
@ -42,7 +42,6 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new {@link ConvertingComparator} instance.
|
* Create a new {@link ConvertingComparator} instance.
|
||||||
*
|
|
||||||
* @param converter the converter
|
* @param converter the converter
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
|
@ -52,7 +51,6 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new {@link ConvertingComparator} instance.
|
* Create a new {@link ConvertingComparator} instance.
|
||||||
*
|
|
||||||
* @param comparator the underlying comparator used to compare the converted values
|
* @param comparator the underlying comparator used to compare the converted values
|
||||||
* @param converter the converter
|
* @param converter the converter
|
||||||
*/
|
*/
|
||||||
|
@ -65,15 +63,14 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new {@link ComparableComparator} instance.
|
* Create a new {@link ComparableComparator} instance.
|
||||||
*
|
|
||||||
* @param comparator the underlying comparator
|
* @param comparator the underlying comparator
|
||||||
* @param conversionService the conversion service
|
* @param conversionService the conversion service
|
||||||
* @param targetType the target type
|
* @param targetType the target type
|
||||||
*/
|
*/
|
||||||
public ConvertingComparator(Comparator<T> comparator,
|
public ConvertingComparator(
|
||||||
ConversionService conversionService, Class<? extends T> targetType) {
|
Comparator<T> comparator, ConversionService conversionService, Class<? extends T> targetType) {
|
||||||
this(comparator, new ConversionServiceConverter<S, T>(
|
|
||||||
conversionService, targetType));
|
this(comparator, new ConversionServiceConverter<S, T>(conversionService, targetType));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -87,14 +84,11 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
/**
|
/**
|
||||||
* Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
|
* Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
|
||||||
* map * entries} based on their {@link java.util.Map.Entry#getKey() keys}.
|
* map * entries} based on their {@link java.util.Map.Entry#getKey() keys}.
|
||||||
*
|
|
||||||
* @param comparator the underlying comparator used to compare keys
|
* @param comparator the underlying comparator used to compare keys
|
||||||
* @return a new {@link ConvertingComparator} instance
|
* @return a new {@link ConvertingComparator} instance
|
||||||
*/
|
*/
|
||||||
public static <K, V> ConvertingComparator<Map.Entry<K, V>, K> mapEntryKeys(
|
public static <K, V> ConvertingComparator<Map.Entry<K, V>, K> mapEntryKeys(Comparator<K> comparator) {
|
||||||
Comparator<K> comparator) {
|
|
||||||
return new ConvertingComparator<Map.Entry<K,V>, K>(comparator, new Converter<Map.Entry<K, V>, K>() {
|
return new ConvertingComparator<Map.Entry<K,V>, K>(comparator, new Converter<Map.Entry<K, V>, K>() {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public K convert(Map.Entry<K, V> source) {
|
public K convert(Map.Entry<K, V> source) {
|
||||||
return source.getKey();
|
return source.getKey();
|
||||||
|
@ -105,14 +99,11 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
|
||||||
/**
|
/**
|
||||||
* Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
|
* Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
|
||||||
* map entries} based on their {@link java.util.Map.Entry#getValue() values}.
|
* map entries} based on their {@link java.util.Map.Entry#getValue() values}.
|
||||||
*
|
|
||||||
* @param comparator the underlying comparator used to compare values
|
* @param comparator the underlying comparator used to compare values
|
||||||
* @return a new {@link ConvertingComparator} instance
|
* @return a new {@link ConvertingComparator} instance
|
||||||
*/
|
*/
|
||||||
public static <K, V> ConvertingComparator<Map.Entry<K, V>, V> mapEntryValues(
|
public static <K, V> ConvertingComparator<Map.Entry<K, V>, V> mapEntryValues(Comparator<V> comparator) {
|
||||||
Comparator<V> comparator) {
|
|
||||||
return new ConvertingComparator<Map.Entry<K,V>, V>(comparator, new Converter<Map.Entry<K, V>, V>() {
|
return new ConvertingComparator<Map.Entry<K,V>, V>(comparator, new Converter<Map.Entry<K, V>, V>() {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public V convert(Map.Entry<K, V> source) {
|
public V convert(Map.Entry<K, V> source) {
|
||||||
return source.getValue();
|
return source.getValue();
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -27,9 +27,9 @@ import org.springframework.util.Assert;
|
||||||
* <p>This is the most flexible of the Converter SPI interfaces, but also the most complex.
|
* <p>This is the most flexible of the Converter SPI interfaces, but also the most complex.
|
||||||
* It is flexible in that a GenericConverter may support converting between multiple source/target
|
* It is flexible in that a GenericConverter may support converting between multiple source/target
|
||||||
* type pairs (see {@link #getConvertibleTypes()}. In addition, GenericConverter implementations
|
* type pairs (see {@link #getConvertibleTypes()}. In addition, GenericConverter implementations
|
||||||
* have access to source/target {@link TypeDescriptor field context} during the type conversion process.
|
* have access to source/target {@link TypeDescriptor field context} during the type conversion
|
||||||
* This allows for resolving source and target field metadata such as annotations and generics
|
* process. This allows for resolving source and target field metadata such as annotations and
|
||||||
* information, which can be used influence the conversion logic.
|
* generics information, which can be used influence the conversion logic.
|
||||||
*
|
*
|
||||||
* <p>This interface should generally not be used when the simpler {@link Converter} or
|
* <p>This interface should generally not be used when the simpler {@link Converter} or
|
||||||
* {@link ConverterFactory} interfaces are sufficient.
|
* {@link ConverterFactory} interfaces are sufficient.
|
||||||
|
@ -49,9 +49,8 @@ public interface GenericConverter {
|
||||||
/**
|
/**
|
||||||
* Return the source and target types which this converter can convert between. Each
|
* Return the source and target types which this converter can convert between. Each
|
||||||
* entry is a convertible source-to-target type pair.
|
* entry is a convertible source-to-target type pair.
|
||||||
* <p>
|
* <p>For {@link ConditionalConverter conditional} converters this method may return
|
||||||
* For {@link ConditionalConverter conditional} converters this method may return
|
* {@code null} to indicate all source-to-target pairs should be considered.
|
||||||
* {@code null} to indicate all source-to-target pairs should be considered. *
|
|
||||||
*/
|
*/
|
||||||
Set<ConvertiblePair> getConvertibleTypes();
|
Set<ConvertiblePair> getConvertibleTypes();
|
||||||
|
|
||||||
|
@ -95,25 +94,25 @@ public interface GenericConverter {
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean equals(Object obj) {
|
public boolean equals(Object other) {
|
||||||
if (this == obj) {
|
if (this == other) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
if (obj == null || obj.getClass() != ConvertiblePair.class) {
|
if (other == null || other.getClass() != ConvertiblePair.class) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
ConvertiblePair other = (ConvertiblePair) obj;
|
ConvertiblePair otherPair = (ConvertiblePair) other;
|
||||||
return this.sourceType.equals(other.sourceType) && this.targetType.equals(other.targetType);
|
return (this.sourceType.equals(otherPair.sourceType) && this.targetType.equals(otherPair.targetType));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public int hashCode() {
|
public int hashCode() {
|
||||||
return this.sourceType.hashCode() * 31 + this.targetType.hashCode();
|
return (this.sourceType.hashCode() * 31 + this.targetType.hashCode());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return this.sourceType.getName() + " -> " + this.targetType.getName();
|
return (this.sourceType.getName() + " -> " + this.targetType.getName());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -51,10 +51,10 @@ import java.util.concurrent.locks.ReentrantLock;
|
||||||
* <p>If not explicitly specified, this implementation will use
|
* <p>If not explicitly specified, this implementation will use
|
||||||
* {@linkplain SoftReference soft entry references}.
|
* {@linkplain SoftReference soft entry references}.
|
||||||
*
|
*
|
||||||
* @param <K> The key type
|
|
||||||
* @param <V> The value type
|
|
||||||
* @author Phillip Webb
|
* @author Phillip Webb
|
||||||
* @since 3.2
|
* @since 3.2
|
||||||
|
* @param <K> the key type
|
||||||
|
* @param <V> the value type
|
||||||
*/
|
*/
|
||||||
public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K, V> {
|
public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K, V> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -32,8 +32,8 @@ import org.springframework.util.Assert;
|
||||||
*
|
*
|
||||||
* @author Phillip Webb
|
* @author Phillip Webb
|
||||||
* @since 3.2
|
* @since 3.2
|
||||||
* @param <T> the type of objects being compared
|
|
||||||
* @see CompoundComparator
|
* @see CompoundComparator
|
||||||
|
* @param <T> the type of objects being compared
|
||||||
*/
|
*/
|
||||||
public class InstanceComparator<T> implements Comparator<T> {
|
public class InstanceComparator<T> implements Comparator<T> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -25,10 +25,10 @@ import java.util.concurrent.ExecutionException;
|
||||||
* and {@link ListenableFutureCallback#onSuccess(Object)} call {@link #adapt(Object)}
|
* and {@link ListenableFutureCallback#onSuccess(Object)} call {@link #adapt(Object)}
|
||||||
* on the adaptee's result.
|
* on the adaptee's result.
|
||||||
*
|
*
|
||||||
* @param <T> the type of this {@code Future}
|
|
||||||
* @param <S> the type of the adaptee's {@code Future}
|
|
||||||
* @author Arjen Poutsma
|
* @author Arjen Poutsma
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <T> the type of this {@code Future}
|
||||||
|
* @param <S> the type of the adaptee's {@code Future}
|
||||||
*/
|
*/
|
||||||
public abstract class ListenableFutureAdapter<T, S> extends FutureAdapter<T, S> implements ListenableFuture<T> {
|
public abstract class ListenableFutureAdapter<T, S> extends FutureAdapter<T, S> implements ListenableFuture<T> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -22,12 +22,11 @@ import org.springframework.messaging.MessagingException;
|
||||||
/**
|
/**
|
||||||
* Operations for receiving messages from a destination.
|
* Operations for receiving messages from a destination.
|
||||||
*
|
*
|
||||||
* @param <D> the type of destination to receive messages from
|
|
||||||
*
|
|
||||||
* @author Mark Fisher
|
* @author Mark Fisher
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
* @see GenericMessagingTemplate
|
* @see GenericMessagingTemplate
|
||||||
|
* @param <D> the type of destination to receive messages from
|
||||||
*/
|
*/
|
||||||
public interface MessageReceivingOperations<D> {
|
public interface MessageReceivingOperations<D> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -24,12 +24,11 @@ import org.springframework.messaging.MessagingException;
|
||||||
/**
|
/**
|
||||||
* Operations for sending messages to and receiving the reply from a destination.
|
* Operations for sending messages to and receiving the reply from a destination.
|
||||||
*
|
*
|
||||||
* @param <D> the type of destination
|
|
||||||
*
|
|
||||||
* @author Mark Fisher
|
* @author Mark Fisher
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
* @see GenericMessagingTemplate
|
* @see GenericMessagingTemplate
|
||||||
|
* @param <D> the type of destination
|
||||||
*/
|
*/
|
||||||
public interface MessageRequestReplyOperations<D> {
|
public interface MessageRequestReplyOperations<D> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -24,11 +24,10 @@ import org.springframework.messaging.MessagingException;
|
||||||
/**
|
/**
|
||||||
* Operations for sending messages to a destination.
|
* Operations for sending messages to a destination.
|
||||||
*
|
*
|
||||||
* @param <D> the type of destination to send messages to
|
|
||||||
*
|
|
||||||
* @author Mark Fisher
|
* @author Mark Fisher
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <D> the type of destination to send messages to
|
||||||
*/
|
*/
|
||||||
public interface MessageSendingOperations<D> {
|
public interface MessageSendingOperations<D> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -25,10 +25,9 @@ import org.springframework.messaging.Message;
|
||||||
* matched to a specific Message, as well as compared to each other in the
|
* matched to a specific Message, as well as compared to each other in the
|
||||||
* context of a Message to determine which one matches a request more closely.
|
* context of a Message to determine which one matches a request more closely.
|
||||||
*
|
*
|
||||||
* @param <T> The kind of condition that this condition can be combined with or compared to
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <T> the kind of condition that this condition can be combined with or compared to
|
||||||
*/
|
*/
|
||||||
public interface MessageCondition<T> {
|
public interface MessageCondition<T> {
|
||||||
|
|
||||||
|
|
|
@ -58,11 +58,10 @@ import org.springframework.util.ReflectionUtils;
|
||||||
* <p>Also supports discovering and invoking exception handling methods to process
|
* <p>Also supports discovering and invoking exception handling methods to process
|
||||||
* exceptions raised during message handling.
|
* exceptions raised during message handling.
|
||||||
*
|
*
|
||||||
* @param <T> the type of the Object that contains information mapping a
|
|
||||||
* {@link org.springframework.messaging.handler.HandlerMethod} to incoming messages
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <T> the type of the Object that contains information mapping a
|
||||||
|
* {@link org.springframework.messaging.handler.HandlerMethod} to incoming messages
|
||||||
*/
|
*/
|
||||||
public abstract class AbstractMethodMessageHandler<T>
|
public abstract class AbstractMethodMessageHandler<T>
|
||||||
implements MessageHandler, ApplicationContextAware, InitializingBean {
|
implements MessageHandler, ApplicationContextAware, InitializingBean {
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -22,10 +22,9 @@ import org.springframework.messaging.Message;
|
||||||
* A contract for managing lifecycle events for a TCP connection including
|
* A contract for managing lifecycle events for a TCP connection including
|
||||||
* the handling of incoming messages.
|
* the handling of incoming messages.
|
||||||
*
|
*
|
||||||
* @param <P> the type of payload for in and outbound messages
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <P> the type of payload for in and outbound messages
|
||||||
*/
|
*/
|
||||||
public interface TcpConnectionHandler<P> {
|
public interface TcpConnectionHandler<P> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -21,10 +21,9 @@ import org.springframework.util.concurrent.ListenableFuture;
|
||||||
/**
|
/**
|
||||||
* A contract for establishing TCP connections.
|
* A contract for establishing TCP connections.
|
||||||
*
|
*
|
||||||
* @param <P> the type of payload for in and outbound messages
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <P> the type of payload for in and outbound messages
|
||||||
*/
|
*/
|
||||||
public interface TcpOperations<P> {
|
public interface TcpOperations<P> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -34,11 +34,10 @@ import org.springframework.util.concurrent.SuccessCallback;
|
||||||
* Adapts a reactor {@link Promise} to {@link ListenableFuture} optionally converting
|
* Adapts a reactor {@link Promise} to {@link ListenableFuture} optionally converting
|
||||||
* the result Object type {@code <S>} to the expected target type {@code <T>}.
|
* the result Object type {@code <S>} to the expected target type {@code <T>}.
|
||||||
*
|
*
|
||||||
* @param <S> the type of object expected from the {@link Promise}
|
|
||||||
* @param <T> the type of object expected from the {@link ListenableFuture}
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
|
* @param <S> the type of object expected from the {@link Promise}
|
||||||
|
* @param <T> the type of object expected from the {@link ListenableFuture}
|
||||||
*/
|
*/
|
||||||
abstract class AbstractPromiseToListenableFutureAdapter<S, T> implements ListenableFuture<T> {
|
abstract class AbstractPromiseToListenableFutureAdapter<S, T> implements ListenableFuture<T> {
|
||||||
|
|
||||||
|
@ -113,4 +112,5 @@ abstract class AbstractPromiseToListenableFutureAdapter<S, T> implements Listena
|
||||||
this.registry.addSuccessCallback(successCallback);
|
this.registry.addSuccessCallback(successCallback);
|
||||||
this.registry.addFailureCallback(failureCallback);
|
this.registry.addFailureCallback(failureCallback);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -23,15 +23,14 @@ import org.springframework.messaging.Message;
|
||||||
import org.springframework.messaging.tcp.TcpConnection;
|
import org.springframework.messaging.tcp.TcpConnection;
|
||||||
import org.springframework.util.concurrent.ListenableFuture;
|
import org.springframework.util.concurrent.ListenableFuture;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An implementation of {@link org.springframework.messaging.tcp.TcpConnection}
|
* An implementation of {@link org.springframework.messaging.tcp.TcpConnection}
|
||||||
* based on the TCP client support of the Reactor project.
|
* based on the TCP client support of the Reactor project.
|
||||||
*
|
*
|
||||||
* @param <P> the payload type of Spring Message's read from
|
|
||||||
* and written to the TCP stream
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
|
* @since 4.0
|
||||||
|
* @param <P> the payload type of Spring Message's read from and written to
|
||||||
|
* the TCP stream
|
||||||
*/
|
*/
|
||||||
public class Reactor11TcpConnection<P> implements TcpConnection<P> {
|
public class Reactor11TcpConnection<P> implements TcpConnection<P> {
|
||||||
|
|
||||||
|
@ -42,6 +41,7 @@ public class Reactor11TcpConnection<P> implements TcpConnection<P> {
|
||||||
this.channel = connection;
|
this.channel = connection;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public ListenableFuture<Void> send(Message<P> message) {
|
public ListenableFuture<Void> send(Message<P> message) {
|
||||||
Promise<Void> promise = this.channel.send(message);
|
Promise<Void> promise = this.channel.send(message);
|
||||||
|
|
|
@ -325,8 +325,8 @@ public class RequestEntity<T> extends HttpEntity<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the body of the request entity and build the RequestEntity.
|
* Set the body of the request entity and build the RequestEntity.
|
||||||
* @param body the body of the request entity
|
|
||||||
* @param <T> the type of the body
|
* @param <T> the type of the body
|
||||||
|
* @param body the body of the request entity
|
||||||
* @return the built request entity
|
* @return the built request entity
|
||||||
*/
|
*/
|
||||||
<T> RequestEntity<T> body(T body);
|
<T> RequestEntity<T> body(T body);
|
||||||
|
|
|
@ -368,8 +368,8 @@ public class ResponseEntity<T> extends HttpEntity<T> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the body of the response entity and returns it.
|
* Set the body of the response entity and returns it.
|
||||||
* @param body the body of the response entity
|
|
||||||
* @param <T> the type of the body
|
* @param <T> the type of the body
|
||||||
|
* @param body the body of the response entity
|
||||||
* @return the built response entity
|
* @return the built response entity
|
||||||
*/
|
*/
|
||||||
<T> ResponseEntity<T> body(T body);
|
<T> ResponseEntity<T> body(T body);
|
||||||
|
|
|
@ -46,13 +46,12 @@ import org.springframework.web.servlet.HandlerMapping;
|
||||||
* <p>For each registered handler method, a unique mapping is maintained with
|
* <p>For each registered handler method, a unique mapping is maintained with
|
||||||
* subclasses defining the details of the mapping type {@code <T>}.
|
* subclasses defining the details of the mapping type {@code <T>}.
|
||||||
*
|
*
|
||||||
* @param <T> The mapping for a {@link HandlerMethod} containing the conditions
|
|
||||||
* needed to match the handler method to incoming request.
|
|
||||||
*
|
|
||||||
* @author Arjen Poutsma
|
* @author Arjen Poutsma
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @author Juergen Hoeller
|
* @author Juergen Hoeller
|
||||||
* @since 3.1
|
* @since 3.1
|
||||||
|
* @param <T> The mapping for a {@link HandlerMethod} containing the conditions
|
||||||
|
* needed to match the handler method to incoming request.
|
||||||
*/
|
*/
|
||||||
public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMapping implements InitializingBean {
|
public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMapping implements InitializingBean {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2014 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -28,11 +28,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
|
||||||
* to each other via {@link #compareTo(Object, HttpServletRequest)} to determine
|
* to each other via {@link #compareTo(Object, HttpServletRequest)} to determine
|
||||||
* which matches a request more closely.
|
* which matches a request more closely.
|
||||||
*
|
*
|
||||||
* @param <T> the type of objects that this RequestCondition can be combined with and compared to
|
|
||||||
*
|
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @author Arjen Poutsma
|
* @author Arjen Poutsma
|
||||||
* @since 3.1
|
* @since 3.1
|
||||||
|
* @param <T> the type of objects that this RequestCondition can be combined with and compared to
|
||||||
*/
|
*/
|
||||||
public interface RequestCondition<T> {
|
public interface RequestCondition<T> {
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2002-2013 the original author or authors.
|
* Copyright 2002-2015 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -64,12 +64,12 @@ import org.springframework.web.context.ContextLoader;
|
||||||
*
|
*
|
||||||
* @author Phillip Webb
|
* @author Phillip Webb
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
* @param <T> the type being converted to (for Encoder) or from (for Decoder)
|
|
||||||
* @param <M> the WebSocket message type ({@link String} or {@link ByteBuffer})
|
|
||||||
* @see ConvertingEncoderDecoderSupport.BinaryEncoder
|
* @see ConvertingEncoderDecoderSupport.BinaryEncoder
|
||||||
* @see ConvertingEncoderDecoderSupport.BinaryDecoder
|
* @see ConvertingEncoderDecoderSupport.BinaryDecoder
|
||||||
* @see ConvertingEncoderDecoderSupport.TextEncoder
|
* @see ConvertingEncoderDecoderSupport.TextEncoder
|
||||||
* @see ConvertingEncoderDecoderSupport.TextDecoder
|
* @see ConvertingEncoderDecoderSupport.TextDecoder
|
||||||
|
* @param <T> the type being converted to (for Encoder) or from (for Decoder)
|
||||||
|
* @param <M> the WebSocket message type ({@link String} or {@link ByteBuffer})
|
||||||
*/
|
*/
|
||||||
public abstract class ConvertingEncoderDecoderSupport<T, M> {
|
public abstract class ConvertingEncoderDecoderSupport<T, M> {
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue