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

Fix javadoc checkstyle issues

Browse Source 
Fix checkstyle violations for javadoc.

Issue: SPR-16968
This commit is contained in:
Phillip Webb
2018-06-20 18:45:54 -07:00
committed by Juergen Hoeller
parent 032096d699
commit e0480f75ac
928 changed files with 3729 additions and 2686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-core/src/main/java/org/springframework/core/AttributeAccessorSupport.java
View File

@@ -37,7 +37,7 @@ import org.springframework.util.StringUtils;
@SuppressWarnings("serial")
public abstract class AttributeAccessorSupport implements AttributeAccessor, Serializable {
/** Map with String keys and Object values */
/** Map with String keys and Object values. */
private final Map<String, Object> attributes = new LinkedHashMap<>(0);

8
spring-core/src/main/java/org/springframework/core/Constants.java
View File

@@ -46,10 +46,10 @@ import org.springframework.util.ReflectionUtils;
*/
public class Constants {
/** The name of the introspected class */
/** The name of the introspected class. */
private final String className;
/** Map from String field name to object value */
/** Map from String field name to object value. */
private final Map<String, Object> fieldCache = new HashMap<>();
@@ -105,9 +105,9 @@ public class Constants {
* Return a constant value cast to a Number.
* @param code the name of the field (never {@code null})
* @return the Number value
* @see #asObject
* @throws ConstantException if the field name wasn't found
* or if the type wasn't compatible with Number
* @see #asObject
*/
public Number asNumber(String code) throws ConstantException {
Object obj = asObject(code);
@@ -122,8 +122,8 @@ public class Constants {
* @param code the name of the field (never {@code null})
* @return the String value
* Works even if it's not a string (invokes {@code toString()}).
* @see #asObject
* @throws ConstantException if the field name wasn't found
* @see #asObject
*/
public String asString(String code) throws ConstantException {
return asObject(code).toString();

4
spring-core/src/main/java/org/springframework/core/GenericTypeResolver.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -43,7 +43,7 @@ import org.springframework.util.ConcurrentReferenceHashMap;
*/
public abstract class GenericTypeResolver {
/** Cache from Class to TypeVariable Map */
/** Cache from Class to TypeVariable Map. */
@SuppressWarnings("rawtypes")
private static final Map<Class<?>, Map<TypeVariable, Type>> typeVariableCache = new ConcurrentReferenceHashMap<>();

2
spring-core/src/main/java/org/springframework/core/MethodParameter.java
View File

@@ -69,7 +69,7 @@ public class MethodParameter {
private int nestingLevel = 1;
/** Map from Integer level to Integer type index */
/** Map from Integer level to Integer type index. */
@Nullable
Map<Integer, Integer> typeIndexesPerLevel;

3
spring-core/src/main/java/org/springframework/core/NamedInheritableThreadLocal.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2018 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,6 +24,7 @@ import org.springframework.util.Assert;
*
* @author Juergen Hoeller
* @since 2.5.2
* @param <T> the value type
* @see NamedThreadLocal
*/
public class NamedInheritableThreadLocal<T> extends InheritableThreadLocal<T> {

3
spring-core/src/main/java/org/springframework/core/NamedThreadLocal.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2008 the original author or authors.
* Copyright 2002-2018 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,6 +24,7 @@ import org.springframework.util.Assert;
*
* @author Juergen Hoeller
* @since 2.5.2
* @param <T> the value type
* @see NamedInheritableThreadLocal
*/
public class NamedThreadLocal<T> extends ThreadLocal<T> {

4
spring-core/src/main/java/org/springframework/core/NestedCheckedException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,7 +38,7 @@ import org.springframework.lang.Nullable;
*/
public abstract class NestedCheckedException extends Exception {
/** Use serialVersionUID from Spring 1.2 for interoperability */
/** Use serialVersionUID from Spring 1.2 for interoperability. */
private static final long serialVersionUID = 7100714597678207546L;
static {

4
spring-core/src/main/java/org/springframework/core/NestedRuntimeException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,7 +38,7 @@ import org.springframework.lang.Nullable;
*/
public abstract class NestedRuntimeException extends RuntimeException {
/** Use serialVersionUID from Spring 1.2 for interoperability */
/** Use serialVersionUID from Spring 1.2 for interoperability. */
private static final long serialVersionUID = 5439915454935047936L;
static {

4
spring-core/src/main/java/org/springframework/core/OverridingClassLoader.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -36,7 +36,7 @@ import org.springframework.util.FileCopyUtils;
*/
public class OverridingClassLoader extends DecoratingClassLoader {
/** Packages that are excluded by default */
/** Packages that are excluded by default. */
public static final String[] DEFAULT_EXCLUDED_PACKAGES = new String[]
{"java.", "javax.", "sun.", "oracle.", "javassist.", "org.aspectj.", "net.sf.cglib."};

1
spring-core/src/main/java/org/springframework/core/ParameterizedTypeReference.java
View File

@@ -37,6 +37,7 @@ import org.springframework.util.Assert;
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @since 3.2
* @param <T> the referenced type
* @see <a href="http://gafter.blogspot.nl/2006/12/super-type-tokens.html">Neal Gafter on Super Type Tokens</a>
*/
public abstract class ParameterizedTypeReference<T> {

17
spring-core/src/main/java/org/springframework/core/ResolvableType.java
View File

@@ -51,7 +51,7 @@ import org.springframework.util.StringUtils;
* {@link #forMethodParameter(Method, int) method parameters},
* {@link #forMethodReturnType(Method) method returns} or
* {@link #forClass(Class) classes}. Most methods on this class will themselves return
* {@link ResolvableType}s, allowing easy navigation. For example:
* {@link ResolvableType ResolvableTypes}, allowing easy navigation. For example:
* <pre class="code">
* private HashMap&lt;Integer, List&lt;String&gt;&gt; myMap;
*
@@ -654,12 +654,12 @@ public class ResolvableType implements Serializable {
}
/**
* Return an array of {@link ResolvableType}s representing the generic parameters of
* Return an array of {@link ResolvableType ResolvableTypes} representing the generic parameters of
* this type. If no generics are available an empty array is returned. If you need to
* access a specific generic consider using the {@link #getGeneric(int...)} method as
* it allows access to nested generics and protects against
* {@code IndexOutOfBoundsExceptions}.
* @return an array of {@link ResolvableType}s representing the generic parameters
* @return an array of {@link ResolvableType ResolvableTypes} representing the generic parameters
* (never {@code null})
* @see #hasGenerics()
* @see #getGeneric(int...)
@@ -743,7 +743,7 @@ public class ResolvableType implements Serializable {
/**
* Resolve this type to a {@link java.lang.Class}, returning {@code null}
* if the type cannot be resolved. This method will consider bounds of
* {@link TypeVariable}s and {@link WildcardType}s if direct resolution fails;
* {@link TypeVariable TypeVariables} and {@link WildcardType WildcardTypes} if direct resolution fails;
* however, bounds of {@code Object.class} will be ignored.
* @return the resolved {@link Class}, or {@code null} if not resolvable
* @see #resolve(Class)
@@ -758,7 +758,7 @@ public class ResolvableType implements Serializable {
/**
* Resolve this type to a {@link java.lang.Class}, returning the specified
* {@code fallback} if the type cannot be resolved. This method will consider bounds
* of {@link TypeVariable}s and {@link WildcardType}s if direct resolution fails;
* of {@link TypeVariable TypeVariables} and {@link WildcardType WildcardTypes} if direct resolution fails;
* however, bounds of {@code Object.class} will be ignored.
* @param fallback the fallback class to use if resolution fails
* @return the resolved {@link Class} or the {@code fallback}
@@ -1417,7 +1417,7 @@ public class ResolvableType implements Serializable {
/**
* Strategy interface used to resolve {@link TypeVariable}s.
* Strategy interface used to resolve {@link TypeVariable TypeVariables}.
*/
interface VariableResolver extends Serializable {
@@ -1553,7 +1553,7 @@ public class ResolvableType implements Serializable {
/**
* Internal helper to handle bounds from {@link WildcardType}s.
* Internal helper to handle bounds from {@link WildcardType WildcardTypes}.
*/
private static class WildcardBounds {
@@ -1638,6 +1638,9 @@ public class ResolvableType implements Serializable {
}
/**
* Internal {@link Type} used to represent an empty value.
*/
@SuppressWarnings("serial")
static class EmptyType implements Type, Serializable {

12
spring-core/src/main/java/org/springframework/core/SerializableTypeWrapper.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,7 +38,7 @@ import org.springframework.util.ReflectionUtils;
/**
* Internal utility class that can be used to obtain wrapped {@link Serializable}
* variants of {@link java.lang.reflect.Type}s.
* variants of {@link java.lang.reflect.Type java.lang.reflect.Types}.
*
* <p>{@link #forField(Field) Fields} or {@link #forMethodParameter(MethodParameter)
* MethodParameters} can be used as the root source for a serializable type.
@@ -49,7 +49,7 @@ import org.springframework.util.ReflectionUtils;
* <p>The returned type will either be a {@link Class} or a serializable proxy of
* {@link GenericArrayType}, {@link ParameterizedType}, {@link TypeVariable} or
* {@link WildcardType}. With the exception of {@link Class} (which is final) calls
* to methods that return further {@link Type}s (for example
* to methods that return further {@link Type Types} (for example
* {@link GenericArrayType#getGenericComponentType()}) will be automatically wrapped.
*
* @author Phillip Webb
@@ -251,7 +251,7 @@ abstract class SerializableTypeWrapper {
/**
* {@link TypeProvider} for {@link Type}s obtained from a {@link Field}.
* {@link TypeProvider} for {@link Type Types} obtained from a {@link Field}.
*/
@SuppressWarnings("serial")
static class FieldTypeProvider implements TypeProvider {
@@ -291,7 +291,7 @@ abstract class SerializableTypeWrapper {
/**
* {@link TypeProvider} for {@link Type}s obtained from a {@link MethodParameter}.
* {@link TypeProvider} for {@link Type Types} obtained from a {@link MethodParameter}.
*/
@SuppressWarnings("serial")
static class MethodParameterTypeProvider implements TypeProvider {
@@ -345,7 +345,7 @@ abstract class SerializableTypeWrapper {
/**
* {@link TypeProvider} for {@link Type}s obtained by invoking a no-arg method.
* {@link TypeProvider} for {@link Type Types} obtained by invoking a no-arg method.
*/
@SuppressWarnings("serial")
static class MethodInvokeTypeProvider implements TypeProvider {

4
spring-core/src/main/java/org/springframework/core/SimpleAliasRegistry.java
View File

@@ -40,10 +40,10 @@ import org.springframework.util.StringValueResolver;
*/
public class SimpleAliasRegistry implements AliasRegistry {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
/** Map from alias to canonical name */
/** Map from alias to canonical name. */
private final Map<String, String> aliasMap = new ConcurrentHashMap<>(16);

23
spring-core/src/main/java/org/springframework/core/annotation/AnnotatedElementUtils.java
View File

@@ -443,11 +443,11 @@ public abstract class AnnotatedElementUtils {
* @param annotationType the annotation type to find (never {@code null})
* @return the set of all merged repeatable {@code Annotations} found,
* or an empty set if none were found
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* @since 4.3
* @see #getMergedAnnotation(AnnotatedElement, Class)
* @see #getAllMergedAnnotations(AnnotatedElement, Class)
* @see #getMergedRepeatableAnnotations(AnnotatedElement, Class, Class)
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* is {@code null}, or if the container type cannot be resolved
*/
public static <A extends Annotation> Set<A> getMergedRepeatableAnnotations(AnnotatedElement element,
@@ -474,13 +474,13 @@ public abstract class AnnotatedElementUtils {
* {@link java.lang.annotation.Repeatable}
* @return the set of all merged repeatable {@code Annotations} found,
* or an empty set if none were found
* @since 4.3
* @see #getMergedAnnotation(AnnotatedElement, Class)
* @see #getAllMergedAnnotations(AnnotatedElement, Class)
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* is {@code null}, or if the container type cannot be resolved
* @throws AnnotationConfigurationException if the supplied {@code containerType}
* is not a valid container annotation for the supplied {@code annotationType}
* @since 4.3
* @see #getMergedAnnotation(AnnotatedElement, Class)
* @see #getAllMergedAnnotations(AnnotatedElement, Class)
*/
public static <A extends Annotation> Set<A> getMergedRepeatableAnnotations(AnnotatedElement element,
Class<A> annotationType, @Nullable Class<? extends Annotation> containerType) {
@@ -729,12 +729,12 @@ public abstract class AnnotatedElementUtils {
* @param annotationType the annotation type to find (never {@code null})
* @return the set of all merged repeatable {@code Annotations} found,
* or an empty set if none were found
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* is {@code null}, or if the container type cannot be resolved
* @since 4.3
* @see #findMergedAnnotation(AnnotatedElement, Class)
* @see #findAllMergedAnnotations(AnnotatedElement, Class)
* @see #findMergedRepeatableAnnotations(AnnotatedElement, Class, Class)
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* is {@code null}, or if the container type cannot be resolved
*/
public static <A extends Annotation> Set<A> findMergedRepeatableAnnotations(AnnotatedElement element,
Class<A> annotationType) {
@@ -760,13 +760,13 @@ public abstract class AnnotatedElementUtils {
* {@link java.lang.annotation.Repeatable}
* @return the set of all merged repeatable {@code Annotations} found,
* or an empty set if none were found
* @since 4.3
* @see #findMergedAnnotation(AnnotatedElement, Class)
* @see #findAllMergedAnnotations(AnnotatedElement, Class)
* @throws IllegalArgumentException if the {@code element} or {@code annotationType}
* is {@code null}, or if the container type cannot be resolved
* @throws AnnotationConfigurationException if the supplied {@code containerType}
* is not a valid container annotation for the supplied {@code annotationType}
* @since 4.3
* @see #findMergedAnnotation(AnnotatedElement, Class)
* @see #findAllMergedAnnotations(AnnotatedElement, Class)
*/
public static <A extends Annotation> Set<A> findMergedRepeatableAnnotations(AnnotatedElement element,
Class<A> annotationType, @Nullable Class<? extends Annotation> containerType) {
@@ -1280,9 +1280,9 @@ public abstract class AnnotatedElementUtils {
* annotation for the supplied repeatable {@code annotationType} (i.e.,
* that it declares a {@code value} attribute that holds an array of the
* {@code annotationType}).
* @since 4.3
* @throws AnnotationConfigurationException if the supplied {@code containerType}
* is not a valid container annotation for the supplied {@code annotationType}
* @since 4.3
*/
private static void validateContainerType(Class<? extends Annotation> annotationType,
Class<? extends Annotation> containerType) {
@@ -1305,9 +1305,6 @@ public abstract class AnnotatedElementUtils {
}
}
/**
* @since 4.3
*/
private static <A extends Annotation> Set<A> postProcessAndSynthesizeAggregatedResults(AnnotatedElement element,
Class<A> annotationType, List<AnnotationAttributes> aggregatedResults) {

2
spring-core/src/main/java/org/springframework/core/annotation/AnnotationUtils.java
View File

@@ -1833,8 +1833,8 @@ public abstract class AnnotationUtils {
/**
* Determine if the supplied method is an "annotationType" method.
* @return {@code true} if the method is an "annotationType" method
* @see Annotation#annotationType()
* @since 4.2
* @see Annotation#annotationType()
*/
static boolean isAnnotationTypeMethod(@Nullable Method method) {
return (method != null && method.getName().equals("annotationType") && method.getParameterCount() == 0);

1
spring-core/src/main/java/org/springframework/core/codec/AbstractDataBufferDecoder.java
View File

@@ -43,6 +43,7 @@ import org.springframework.util.MimeType;
*
* @author Rossen Stoyanchev
* @since 5.0
* @param <T> the element type
*/
public abstract class AbstractDataBufferDecoder<T> extends AbstractDecoder<T> {

1
spring-core/src/main/java/org/springframework/core/codec/AbstractDecoder.java
View File

@@ -36,6 +36,7 @@ import org.springframework.util.MimeType;
* @author Sebastien Deleuze
* @author Arjen Poutsma
* @since 5.0
* @param <T> the element type
*/
public abstract class AbstractDecoder<T> implements Decoder<T> {

1
spring-core/src/main/java/org/springframework/core/codec/AbstractEncoder.java
View File

@@ -33,6 +33,7 @@ import org.springframework.util.MimeType;
* @author Sebastien Deleuze
* @author Arjen Poutsma
* @since 5.0
* @param <T> the element type
*/
public abstract class AbstractEncoder<T> implements Encoder<T> {

5
spring-core/src/main/java/org/springframework/core/codec/AbstractSingleValueEncoder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -33,6 +33,7 @@ import org.springframework.util.MimeType;
*
* @author Arjen Poutsma
* @since 5.0
* @param <T> the element type
*/
public abstract class AbstractSingleValueEncoder<T> extends AbstractEncoder<T> {
@@ -57,7 +58,7 @@ public abstract class AbstractSingleValueEncoder<T> extends AbstractEncoder<T> {
* @param dataBufferFactory a buffer factory used to create the output
* @param type the stream element type to process
* @param mimeType the mime type to process
* @param hints Additional information about how to do decode, optional
* @param hints additional information about how to do decode, optional
* @return the output stream
*/
protected abstract Flux<DataBuffer> encode(T t, DataBufferFactory dataBufferFactory,

4
spring-core/src/main/java/org/springframework/core/codec/ByteBufferDecoder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -27,7 +27,7 @@ import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Decoder for {@link ByteBuffer}s.
* Decoder for {@link ByteBuffer ByteBuffers}.
*
* @author Sebastien Deleuze
* @author Arjen Poutsma

2
spring-core/src/main/java/org/springframework/core/codec/ByteBufferEncoder.java
View File

@@ -31,7 +31,7 @@ import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Encoder for {@link ByteBuffer}s.
* Encoder for {@link ByteBuffer ByteBuffers}.
*
* @author Sebastien Deleuze
* @since 5.0

3
spring-core/src/main/java/org/springframework/core/codec/CharSequenceEncoder.java
View File

@@ -44,6 +44,9 @@ import org.springframework.util.MimeTypeUtils;
*/
public class CharSequenceEncoder extends AbstractEncoder<CharSequence> {
/**
* The default charset used by the encoder.
*/
public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;

4
spring-core/src/main/java/org/springframework/core/codec/DataBufferDecoder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Simple pass-through decoder for {@link DataBuffer}s.
* Simple pass-through decoder for {@link DataBuffer DataBuffers}.
* <p><strong>Note</strong> that the "decoded" buffers returned by instances of this class should
* be released after usage by calling
* {@link org.springframework.core.io.buffer.DataBufferUtils#release(DataBuffer)}.

2
spring-core/src/main/java/org/springframework/core/codec/DataBufferEncoder.java
View File

@@ -30,7 +30,7 @@ import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Simple pass-through encoder for {@link DataBuffer}s.
* Simple pass-through encoder for {@link DataBuffer DataBuffers}.
*
* @author Arjen Poutsma
* @since 5.0

4
spring-core/src/main/java/org/springframework/core/codec/ResourceDecoder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -34,7 +34,7 @@ import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Decoder for {@link Resource}s.
* Decoder for {@link Resource Resources}.
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev

5
spring-core/src/main/java/org/springframework/core/codec/ResourceEncoder.java
View File

@@ -33,13 +33,16 @@ import org.springframework.util.MimeTypeUtils;
import org.springframework.util.StreamUtils;
/**
* Encoder for {@link Resource}s.
* Encoder for {@link Resource Resources}.
*
* @author Arjen Poutsma
* @since 5.0
*/
public class ResourceEncoder extends AbstractSingleValueEncoder<Resource> {
/**
* The default buffer size used by the encoder.
*/
public static final int DEFAULT_BUFFER_SIZE = StreamUtils.BUFFER_SIZE;
private final int bufferSize;

8
spring-core/src/main/java/org/springframework/core/codec/ResourceRegionEncoder.java
View File

@@ -41,15 +41,21 @@ import org.springframework.util.MimeTypeUtils;
import org.springframework.util.StreamUtils;
/**
* Encoder for {@link ResourceRegion}s.
* Encoder for {@link ResourceRegion ResourceRegions}.
*
* @author Brian Clozel
* @since 5.0
*/
public class ResourceRegionEncoder extends AbstractEncoder<ResourceRegion> {
/**
* The default buffer size used by the encoder.
*/
public static final int DEFAULT_BUFFER_SIZE = StreamUtils.BUFFER_SIZE;
/**
* The hint key that contains the boundary string.
*/
public static final String BOUNDARY_STRING_HINT = ResourceRegionEncoder.class.getName() + ".boundaryString";
private final int bufferSize;

4
spring-core/src/main/java/org/springframework/core/convert/converter/ConverterFactory.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -23,10 +23,10 @@ package org.springframework.core.convert.converter;
*
* @author Keith Donald
* @since 3.0
* @see ConditionalConverter
* @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;
* for example {@link Number} for a set of number subtypes.
* @see ConditionalConverter
*/
public interface ConverterFactory<S, R> {

4
spring-core/src/main/java/org/springframework/core/convert/support/ByteBufferConverter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.core.convert.converter.ConditionalGenericConverter;
import org.springframework.lang.Nullable;
/**
* Converts a {@link ByteBuffer} directly to and from {@code byte[]}s and indirectly
* Converts a {@link ByteBuffer} directly to and from {@code byte[] ByteBuffer} directly to and from {@code byte[]s} and indirectly
* to any type that the {@link ConversionService} support via {@code byte[]}.
*
* @author Phillip Webb

4
spring-core/src/main/java/org/springframework/core/env/AbstractPropertyResolver.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -217,7 +217,7 @@ public abstract class AbstractPropertyResolver implements ConfigurablePropertyRe
* unresolvable placeholders should raise an exception or be ignored.
* <p>Invoked from {@link #getProperty} and its variants, implicitly resolving
* nested placeholders. In contrast, {@link #resolvePlaceholders} and
* {@link #resolveRequiredPlaceholders} do <emphasis>not</emphasis> delegate
* {@link #resolveRequiredPlaceholders} do <i>not</i> delegate
* to this method but rather perform their own handling of unresolvable
* placeholders, as specified by each of those methods.
* @since 3.2

7
spring-core/src/main/java/org/springframework/core/env/CommandLinePropertySource.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -200,16 +200,17 @@ import org.springframework.util.StringUtils;
*
* @author Chris Beams
* @since 3.1
* @param <T> the source type
* @see PropertySource
* @see SimpleCommandLinePropertySource
* @see JOptCommandLinePropertySource
*/
public abstract class CommandLinePropertySource<T> extends EnumerablePropertySource<T> {
/** The default name given to {@link CommandLinePropertySource} instances: {@value} */
/** The default name given to {@link CommandLinePropertySource} instances: {@value}. */
public static final String COMMAND_LINE_PROPERTY_SOURCE_NAME = "commandLineArgs";
/** The default name of the property representing non-option arguments: {@value} */
/** The default name of the property representing non-option arguments: {@value}. */
public static final String DEFAULT_NON_OPTION_ARGS_PROPERTY_NAME = "nonOptionArgs";

10
spring-core/src/main/java/org/springframework/core/env/ConfigurableEnvironment.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -37,7 +37,7 @@ import java.util.Map;
* <pre class="code">
* ConfigurableEnvironment environment = new StandardEnvironment();
* MutablePropertySources propertySources = environment.getPropertySources();
* Map<String, String> myMap = new HashMap<String, String>();
* Map&lt;String, String&gt; myMap = new HashMap&lt;&gt;();
* myMap.put("xyz", "myValue");
* propertySources.addFirst(new MapPropertySource("MY_MAP", myMap));
* </pre>
@@ -78,26 +78,26 @@ public interface ConfigurableEnvironment extends Environment, ConfigurableProper
* <p>Any existing active profiles will be replaced with the given arguments; call
* with zero arguments to clear the current set of active profiles. Use
* {@link #addActiveProfile} to add a profile while preserving the existing set.
* @throws IllegalArgumentException if any profile is null, empty or whitespace-only
* @see #addActiveProfile
* @see #setDefaultProfiles
* @see org.springframework.context.annotation.Profile
* @see AbstractEnvironment#ACTIVE_PROFILES_PROPERTY_NAME
* @throws IllegalArgumentException if any profile is null, empty or whitespace-only
*/
void setActiveProfiles(String... profiles);
/**
* Add a profile to the current set of active profiles.
* @see #setActiveProfiles
* @throws IllegalArgumentException if the profile is null, empty or whitespace-only
* @see #setActiveProfiles
*/
void addActiveProfile(String profile);
/**
* Specify the set of profiles to be made active by default if no other profiles
* are explicitly made active through {@link #setActiveProfiles}.
* @see AbstractEnvironment#DEFAULT_PROFILES_PROPERTY_NAME
* @throws IllegalArgumentException if any profile is null, empty or whitespace-only
* @see AbstractEnvironment#DEFAULT_PROFILES_PROPERTY_NAME
*/
void setDefaultProfiles(String... profiles);

3
spring-core/src/main/java/org/springframework/core/env/EnumerablePropertySource.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2018 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.
@@ -40,6 +40,7 @@ import org.springframework.util.ObjectUtils;
* @author Chris Beams
* @author Juergen Hoeller
* @since 3.1
* @param <T> the source type
*/
public abstract class EnumerablePropertySource<T> extends PropertySource<T> {

8
spring-core/src/main/java/org/springframework/core/env/PropertySource.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -50,6 +50,7 @@ import org.springframework.util.ObjectUtils;
*
* @author Chris Beams
* @since 3.1
* @param <T> the source type
* @see PropertySources
* @see PropertyResolver
* @see PropertySourcesPropertyResolver
@@ -88,7 +89,7 @@ public abstract class PropertySource<T> {
/**
* Return the name of this {@code PropertySource}
* Return the name of this {@code PropertySource}.
*/
public String getName() {
return this.name;
@@ -218,6 +219,9 @@ public abstract class PropertySource<T> {
/**
* A {@code PropertySource} implementation intended for collection comparison
* purposes.
*
* @see PropertySource#named(String)
*/
static class ComparisonPropertySource extends StubPropertySource {

4
spring-core/src/main/java/org/springframework/core/env/ReadOnlySystemAttributesMap.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -45,6 +45,8 @@ abstract class ReadOnlySystemAttributesMap implements Map<String, String> {
}
/**
* Returns the value to which the specified key is mapped, or {@code null} if this map
* contains no mapping for the key.
* @param key the name of the system attribute to retrieve
* @throws IllegalArgumentException if given key is non-String
*/

6
spring-core/src/main/java/org/springframework/core/env/StandardEnvironment.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2018 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.
@@ -53,10 +53,10 @@ package org.springframework.core.env;
*/
public class StandardEnvironment extends AbstractEnvironment {
/** System environment property source name: {@value} */
/** System environment property source name: {@value}. */
public static final String SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME = "systemEnvironment";
/** JVM system properties property source name: {@value} */
/** JVM system properties property source name: {@value}. */
public static final String SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME = "systemProperties";

2
spring-core/src/main/java/org/springframework/core/io/PathResource.java
View File

@@ -87,8 +87,8 @@ public class PathResource extends AbstractResource implements WritableResource {
* <p>Note: Unlike {@link FileSystemResource}, when building relative resources
* via {@link #createRelative}, the relative path will be built <i>underneath</i>
* the given root: e.g. Paths.get("C:/dir1/"), relative path "dir2" -> "C:/dir1/dir2"!
* @see java.nio.file.Paths#get(URI)
* @param uri a path URI
* @see java.nio.file.Paths#get(URI)
*/
public PathResource(URI uri) {
Assert.notNull(uri, "URI must not be null");

2
spring-core/src/main/java/org/springframework/core/io/ResourceLoader.java
View File

@@ -41,7 +41,7 @@ import org.springframework.util.ResourceUtils;
*/
public interface ResourceLoader {
/** Pseudo URL prefix for loading from the class path: "classpath:" */
/** Pseudo URL prefix for loading from the class path: "classpath:". */
String CLASSPATH_URL_PREFIX = ResourceUtils.CLASSPATH_URL_PREFIX;

2
spring-core/src/main/java/org/springframework/core/io/buffer/DataBufferFactory.java
View File

@@ -20,7 +20,7 @@ import java.nio.ByteBuffer;
import java.util.List;
/**
* A factory for {@link DataBuffer}s, allowing for allocation and wrapping of
* A factory for {@link DataBuffer DataBuffers}, allowing for allocation and wrapping of
* data buffers.
*
* @author Arjen Poutsma

8
spring-core/src/main/java/org/springframework/core/io/buffer/DataBufferUtils.java
View File

@@ -46,7 +46,7 @@ import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Utility class for working with {@link DataBuffer}s.
* Utility class for working with {@link DataBuffer DataBuffers}.
*
* @author Arjen Poutsma
* @author Brian Clozel
@@ -289,7 +289,7 @@ public abstract class DataBufferUtils {
//---------------------------------------------------------------------
/**
* Write the given stream of {@link DataBuffer}s to the given {@code OutputStream}. Does
* Write the given stream of {@link DataBuffer DataBuffers} to the given {@code OutputStream}. Does
* <strong>not</strong> close the output stream when the flux is terminated, and does
* <strong>not</strong> {@linkplain #release(DataBuffer) release} the data buffers in the
* source. If releasing is required, then subscribe to the returned {@code Flux} with a
@@ -309,7 +309,7 @@ public abstract class DataBufferUtils {
}
/**
* Write the given stream of {@link DataBuffer}s to the given {@code WritableByteChannel}. Does
* Write the given stream of {@link DataBuffer DataBuffers} to the given {@code WritableByteChannel}. Does
* <strong>not</strong> close the channel when the flux is terminated, and does
* <strong>not</strong> {@linkplain #release(DataBuffer) release} the data buffers in the
* source. If releasing is required, then subscribe to the returned {@code Flux} with a
@@ -344,7 +344,7 @@ public abstract class DataBufferUtils {
}
/**
* Write the given stream of {@link DataBuffer}s to the given {@code AsynchronousFileChannel}.
* Write the given stream of {@link DataBuffer DataBuffers} to the given {@code AsynchronousFileChannel}.
* Does <strong>not</strong> close the channel when the flux is terminated, and does
* <strong>not</strong> {@linkplain #release(DataBuffer) release} the data buffers in the
* source. If releasing is required, then subscribe to the returned {@code Flux} with a

1
spring-core/src/main/java/org/springframework/core/io/buffer/DefaultDataBuffer.java
View File

@@ -384,6 +384,7 @@ public class DefaultDataBuffer implements DataBuffer {
}
/**
* Calculate the capacity of the buffer.
* @see io.netty.buffer.AbstractByteBufAllocator#calculateNewCapacity(int, int)
*/
private int calculateCapacity(int neededCapacity) {

2
spring-core/src/main/java/org/springframework/core/io/buffer/NettyDataBuffer.java
View File

@@ -215,7 +215,7 @@ public class NettyDataBuffer implements PooledDataBuffer {
}
/**
* Writes one or more Netty {@link ByteBuf}s to this buffer, starting at the current
* Writes one or more Netty {@link ByteBuf ByteBufs} to this buffer, starting at the current
* writing position.
* @param byteBufs the buffers to write into this buffer
* @return this buffer

4
spring-core/src/main/java/org/springframework/core/io/support/LocalizedResourceHelper.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -33,7 +33,7 @@ import org.springframework.util.Assert;
*/
public class LocalizedResourceHelper {
/** The default separator to use inbetween file name parts: an underscore */
/** The default separator to use inbetween file name parts: an underscore. */
public static final String DEFAULT_SEPARATOR = "_";

2
spring-core/src/main/java/org/springframework/core/io/support/PathMatchingResourcePatternResolver.java
View File

@@ -172,7 +172,7 @@ import org.springframework.util.StringUtils;
* @author Colin Sampaleanu
* @author Marius Bogoevici
* @author Costin Leau
* @author Phil Webb
* @author Phillip Webb
* @since 1.0.2
* @see #CLASSPATH_ALL_URL_PREFIX
* @see org.springframework.util.AntPathMatcher

4
spring-core/src/main/java/org/springframework/core/io/support/PropertiesLoaderSupport.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -40,7 +40,7 @@ import org.springframework.util.PropertiesPersister;
*/
public abstract class PropertiesLoaderSupport {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
@Nullable

4
spring-core/src/main/java/org/springframework/core/io/support/ResourcePropertySource.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2018 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.
@@ -44,7 +44,7 @@ import org.springframework.util.StringUtils;
*/
public class ResourcePropertySource extends PropertiesPropertySource {
/** The original resource name, if different from the given name */
/** The original resource name, if different from the given name. */
@Nullable
private final String resourceName;

8
spring-core/src/main/java/org/springframework/core/io/support/ResourceRegion.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -54,21 +54,21 @@ public class ResourceRegion {
/**
* Return the underlying {@link Resource} for this {@code ResourceRegion}
* Return the underlying {@link Resource} for this {@code ResourceRegion}.
*/
public Resource getResource() {
return this.resource;
}
/**
* Return the start position of this region in the underlying {@link Resource}
* Return the start position of this region in the underlying {@link Resource}.
*/
public long getPosition() {
return this.position;
}
/**
* Return the byte count of this region in the underlying {@link Resource}
* Return the byte count of this region in the underlying {@link Resource}.
*/
public long getCount() {
return this.count;

4
spring-core/src/main/java/org/springframework/core/io/support/SpringFactoriesLoader.java
View File

@@ -82,9 +82,9 @@ public abstract class SpringFactoriesLoader {
* to obtain all registered factory names.
* @param factoryClass the interface or abstract class representing the factory
* @param classLoader the ClassLoader to use for loading (can be {@code null} to use the default)
* @see #loadFactoryNames
* @throws IllegalArgumentException if any factory implementation class cannot
* be loaded or if an error occurs while instantiating any factory
* @see #loadFactoryNames
*/
public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {
Assert.notNull(factoryClass, "'factoryClass' must not be null");
@@ -111,8 +111,8 @@ public abstract class SpringFactoriesLoader {
* @param factoryClass the interface or abstract class representing the factory
* @param classLoader the ClassLoader to use for loading resources; can be
* {@code null} to use the default
* @see #loadFactories
* @throws IllegalArgumentException if an error occurs while loading factory names
* @see #loadFactories
*/
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();

3
spring-core/src/main/java/org/springframework/core/serializer/Deserializer.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -25,6 +25,7 @@ import java.io.InputStream;
* @author Gary Russell
* @author Mark Fisher
* @since 3.0.5
* @param <T> the object type
*/
@FunctionalInterface
public interface Deserializer<T> {

3
spring-core/src/main/java/org/springframework/core/serializer/Serializer.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -25,6 +25,7 @@ import java.io.OutputStream;
* @author Gary Russell
* @author Mark Fisher
* @since 3.0.5
* @param <T> the object type
*/
@FunctionalInterface
public interface Serializer<T> {

4
spring-core/src/main/java/org/springframework/core/style/ToStringCreator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -169,7 +169,7 @@ public class ToStringCreator {
/**
* Append the provided value.
* @param value The value to append
* @param value the value to append
* @return this, to support call-chaining.
*/
public ToStringCreator append(Object value) {

4
spring-core/src/main/java/org/springframework/core/task/AsyncListenableTaskExecutor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2018 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.util.concurrent.ListenableFuture;
/**
* Extension of the {@link AsyncTaskExecutor} interface, adding the capability to submit
* tasks for {@link ListenableFuture}s.
* tasks for {@link ListenableFuture ListenableFutures}.
*
* @author Arjen Poutsma
* @since 4.0

6
spring-core/src/main/java/org/springframework/core/task/AsyncTaskExecutor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2018 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.
@@ -41,10 +41,10 @@ import java.util.concurrent.Future;
*/
public interface AsyncTaskExecutor extends TaskExecutor {
/** Constant that indicates immediate execution */
/** Constant that indicates immediate execution. */
long TIMEOUT_IMMEDIATE = 0;
/** Constant that indicates no time limit */
/** Constant that indicates no time limit. */
long TIMEOUT_INDEFINITE = Long.MAX_VALUE;

4
spring-core/src/main/java/org/springframework/core/task/SimpleAsyncTaskExecutor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -64,7 +64,7 @@ public class SimpleAsyncTaskExecutor extends CustomizableThreadCreator
public static final int NO_CONCURRENCY = ConcurrencyThrottleSupport.NO_CONCURRENCY;
/** Internal concurrency throttle used by this executor */
/** Internal concurrency throttle used by this executor. */
private final ConcurrencyThrottleAdapter concurrencyThrottle = new ConcurrencyThrottleAdapter();
@Nullable

4
spring-core/src/main/java/org/springframework/core/type/classreading/AbstractRecursiveAnnotationVisitor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -31,6 +31,8 @@ import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;
/**
* {@link AnnotationVisitor} to recursively visit annotations.
*
* @author Chris Beams
* @author Juergen Hoeller
* @author Phillip Webb

6
spring-core/src/main/java/org/springframework/core/type/classreading/CachingMetadataReaderFactory.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -37,10 +37,10 @@ import org.springframework.lang.Nullable;
*/
public class CachingMetadataReaderFactory extends SimpleMetadataReaderFactory {
/** Default maximum number of entries for a local MetadataReader cache: 256 */
/** Default maximum number of entries for a local MetadataReader cache: 256. */
public static final int DEFAULT_CACHE_LIMIT = 256;
/** MetadataReader cache: either local or shared at the ResourceLoader level */
/** MetadataReader cache: either local or shared at the ResourceLoader level. */
@Nullable
private Map<Resource, MetadataReader> metadataReaderCache;

2
spring-core/src/main/java/org/springframework/core/type/classreading/RecursiveAnnotationArrayVisitor.java
View File

@@ -27,6 +27,8 @@ import org.springframework.lang.Nullable;
import org.springframework.util.ObjectUtils;
/**
* {@link AnnotationVisitor} to recursively visit annotation arrays.
*
* @author Chris Beams
* @author Juergen Hoeller
* @since 3.1.1

5
spring-core/src/main/java/org/springframework/core/type/classreading/RecursiveAnnotationAttributesVisitor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,11 +16,14 @@
package org.springframework.core.type.classreading;
import org.springframework.asm.AnnotationVisitor;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.lang.Nullable;
/**
* {@link AnnotationVisitor} to recursively visit annotation attributes.
*
* @author Chris Beams
* @author Juergen Hoeller
* @since 3.1.1

2
spring-core/src/main/java/org/springframework/util/AntPathMatcher.java
View File

@@ -72,7 +72,7 @@ import org.springframework.lang.Nullable;
*/
public class AntPathMatcher implements PathMatcher {
/** Default path separator: "/" */
/** Default path separator: "/". */
public static final String DEFAULT_PATH_SEPARATOR = "/";
private static final int CACHE_TURNOFF_THRESHOLD = 65536;

28
spring-core/src/main/java/org/springframework/util/Assert.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -96,6 +96,8 @@ public abstract class Assert {
}
/**
* Assert a boolean expression, throwing an {@code IllegalStateException}
* if the expression evaluates to {@code false}.
* @deprecated as of 4.3.7, in favor of {@link #state(boolean, String)}
*/
@Deprecated
@@ -136,6 +138,8 @@ public abstract class Assert {
}
/**
* Assert a boolean expression, throwing an {@code IllegalArgumentException}
* if the expression evaluates to {@code false}.
* @deprecated as of 4.3.7, in favor of {@link #isTrue(boolean, String)}
*/
@Deprecated
@@ -174,6 +178,7 @@ public abstract class Assert {
}
/**
* Assert that an object is {@code null}.
* @deprecated as of 4.3.7, in favor of {@link #isNull(Object, String)}
*/
@Deprecated
@@ -212,6 +217,7 @@ public abstract class Assert {
}
/**
* Assert that an object is not {@code null}.
* @deprecated as of 4.3.7, in favor of {@link #notNull(Object, String)}
*/
@Deprecated
@@ -225,8 +231,8 @@ public abstract class Assert {
* <pre class="code">Assert.hasLength(name, "Name must not be empty");</pre>
* @param text the String to check
* @param message the exception message to use if the assertion fails
* @see StringUtils#hasLength
* @throws IllegalArgumentException if the text is empty
* @see StringUtils#hasLength
*/
public static void hasLength(@Nullable String text, String message) {
if (!StringUtils.hasLength(text)) {
@@ -243,9 +249,9 @@ public abstract class Assert {
* @param text the String to check
* @param messageSupplier a supplier for the exception message to use if the
* assertion fails
* @see StringUtils#hasLength
* @throws IllegalArgumentException if the text is empty
* @since 5.0
* @see StringUtils#hasLength
*/
public static void hasLength(@Nullable String text, Supplier<String> messageSupplier) {
if (!StringUtils.hasLength(text)) {
@@ -254,6 +260,8 @@ public abstract class Assert {
}
/**
* Assert that the given String is not empty; that is,
* it must not be {@code null} and not the empty String.
* @deprecated as of 4.3.7, in favor of {@link #hasLength(String, String)}
*/
@Deprecated
@@ -268,8 +276,8 @@ public abstract class Assert {
* <pre class="code">Assert.hasText(name, "'name' must not be empty");</pre>
* @param text the String to check
* @param message the exception message to use if the assertion fails
* @see StringUtils#hasText
* @throws IllegalArgumentException if the text does not contain valid text content
* @see StringUtils#hasText
*/
public static void hasText(@Nullable String text, String message) {
if (!StringUtils.hasText(text)) {
@@ -286,9 +294,9 @@ public abstract class Assert {
* @param text the String to check
* @param messageSupplier a supplier for the exception message to use if the
* assertion fails
* @see StringUtils#hasText
* @throws IllegalArgumentException if the text does not contain valid text content
* @since 5.0
* @see StringUtils#hasText
*/
public static void hasText(@Nullable String text, Supplier<String> messageSupplier) {
if (!StringUtils.hasText(text)) {
@@ -297,6 +305,8 @@ public abstract class Assert {
}
/**
* Assert that the given String contains valid text content; that is, it must not
* be {@code null} and must contain at least one non-whitespace character.
* @deprecated as of 4.3.7, in favor of {@link #hasText(String, String)}
*/
@Deprecated
@@ -340,6 +350,7 @@ public abstract class Assert {
}
/**
* Assert that the given text does not contain the given substring.
* @deprecated as of 4.3.7, in favor of {@link #doesNotContain(String, String, String)}
*/
@Deprecated
@@ -381,6 +392,8 @@ public abstract class Assert {
}
/**
* Assert that an array contains elements; that is, it must not be
* {@code null} and must contain at least one element.
* @deprecated as of 4.3.7, in favor of {@link #notEmpty(Object[], String)}
*/
@Deprecated
@@ -429,6 +442,7 @@ public abstract class Assert {
}
/**
* Assert that an array contains no {@code null} elements.
* @deprecated as of 4.3.7, in favor of {@link #noNullElements(Object[], String)}
*/
@Deprecated
@@ -471,6 +485,8 @@ public abstract class Assert {
}
/**
* Assert that a collection contains elements; that is, it must not be
* {@code null} and must contain at least one element.
* @deprecated as of 4.3.7, in favor of {@link #notEmpty(Collection, String)}
*/
@Deprecated
@@ -512,6 +528,8 @@ public abstract class Assert {
}
/**
* Assert that a Map contains entries; that is, it must not be {@code null}
* and must contain at least one entry.
* @deprecated as of 4.3.7, in favor of {@link #notEmpty(Map, String)}
*/
@Deprecated

5
spring-core/src/main/java/org/springframework/util/AutoPopulatingList.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -39,6 +39,7 @@ import java.util.ListIterator;
* @author Rob Harrop
* @author Juergen Hoeller
* @since 2.0
* @param <E> the element type
*/
@SuppressWarnings("serial")
public class AutoPopulatingList<E> implements List<E>, Serializable {
@@ -243,6 +244,8 @@ public class AutoPopulatingList<E> implements List<E>, Serializable {
/**
* Factory interface for creating elements for an index-based access
* data structure such as a {@link java.util.List}.
*
* @param <E> the element type
*/
@FunctionalInterface
public interface ElementFactory<E> {

20
spring-core/src/main/java/org/springframework/util/ClassUtils.java
View File

@@ -55,28 +55,28 @@ import org.springframework.lang.Nullable;
*/
public abstract class ClassUtils {
/** Suffix for array class names: "[]" */
/** Suffix for array class names: {@code "[]"}. */
public static final String ARRAY_SUFFIX = "[]";
/** Prefix for internal array class names: "[" */
/** Prefix for internal array class names: {@code "["}. */
private static final String INTERNAL_ARRAY_PREFIX = "[";
/** Prefix for internal non-primitive array class names: "[L" */
/** Prefix for internal non-primitive array class names: {@code "[L"}. */
private static final String NON_PRIMITIVE_ARRAY_PREFIX = "[L";
/** The package separator character: '.' */
/** The package separator character: {@code '.'}. */
private static final char PACKAGE_SEPARATOR = '.';
/** The path separator character: '/' */
/** The path separator character: {@code '/'}. */
private static final char PATH_SEPARATOR = '/';
/** The inner class separator character: '$' */
/** The inner class separator character: {@code '$'}. */
private static final char INNER_CLASS_SEPARATOR = '$';
/** The CGLIB class separator: "$$" */
/** The CGLIB class separator: {@code "$$"}. */
public static final String CGLIB_CLASS_SEPARATOR = "$$";
/** The ".class" file suffix */
/** The ".class" file suffix. */
public static final String CLASS_FILE_SUFFIX = ".class";
@@ -227,7 +227,7 @@ public abstract class ClassUtils {
* @param name the name of the Class
* @param classLoader the class loader to use
* (may be {@code null}, which indicates the default class loader)
* @return Class instance for the supplied name
* @return a class instance for the supplied name
* @throws ClassNotFoundException if the class was not found
* @throws LinkageError if the class file could not be loaded
* @see Class#forName(String, boolean, ClassLoader)
@@ -298,7 +298,7 @@ public abstract class ClassUtils {
* @param className the name of the Class
* @param classLoader the class loader to use
* (may be {@code null}, which indicates the default class loader)
* @return Class instance for the supplied name
* @return a class instance for the supplied name
* @throws IllegalArgumentException if the class name was not resolvable
* (that is, the class could not be found or the class file could not be loaded)
* @see #forName(String, ClassLoader)

3
spring-core/src/main/java/org/springframework/util/CompositeIterator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -31,6 +31,7 @@ import java.util.Set;
* @author Erwin Vervaet
* @author Juergen Hoeller
* @since 3.0
* @param <E> the element type
*/
public class CompositeIterator<E> implements Iterator<E> {

4
spring-core/src/main/java/org/springframework/util/ConcurrencyThrottleSupport.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -57,7 +57,7 @@ public abstract class ConcurrencyThrottleSupport implements Serializable {
public static final int NO_CONCURRENCY = 0;
/** Transient to optimize serialization */
/** Transient to optimize serialization. */
protected transient Log logger = LogFactory.getLog(getClass());
private transient Object monitor = new Object();

16
spring-core/src/main/java/org/springframework/util/ConcurrentReferenceHashMap.java
View File

@@ -433,10 +433,10 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
*/
public enum ReferenceType {
/** Use {@link SoftReference}s */
/** Use {@link SoftReference SoftReferences}. */
SOFT,
/** Use {@link WeakReference}s */
/** Use {@link WeakReference WeakReferences}. */
WEAK
}
@@ -667,6 +667,9 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
/**
* A reference to an {@link Entry} contained in the map. Implementations are usually
* wrappers around specific Java reference implementations (e.g., {@link SoftReference}).
*
* @param <K> the key type
* @param <V> the value type
*/
protected interface Reference<K, V> {
@@ -697,6 +700,9 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
/**
* A single map entry.
*
* @param <K> the key type
* @param <V> the value type
*/
protected static final class Entry<K, V> implements Map.Entry<K, V> {
@@ -960,7 +966,7 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
/**
* Strategy class used to manage {@link Reference}s. This class can be overridden if
* Strategy class used to manage {@link Reference References}. This class can be overridden if
* alternative reference types need to be supported.
*/
protected class ReferenceManager {
@@ -997,7 +1003,7 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
/**
* Internal {@link Reference} implementation for {@link SoftReference}s.
* Internal {@link Reference} implementation for {@link SoftReference Reference} implementation for {@link SoftReferences}.
*/
private static final class SoftEntryReference<K, V> extends SoftReference<Entry<K, V>> implements Reference<K, V> {
@@ -1034,7 +1040,7 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen
/**
* Internal {@link Reference} implementation for {@link WeakReference}s.
* Internal {@link Reference} implementation for {@link WeakReference Reference} implementation for {@link WeakReferences}.
*/
private static final class WeakEntryReference<K, V> extends WeakReference<Entry<K, V>> implements Reference<K, V> {

6
spring-core/src/main/java/org/springframework/util/FastByteArrayOutputStream.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -469,7 +469,7 @@ public class FastByteArrayOutputStream extends OutputStream {
/**
* Update the message digest with the remaining bytes in this stream.
* @param messageDigest The message digest to update
* @param messageDigest the message digest to update
*/
@Override
public void updateMessageDigest(MessageDigest messageDigest) {
@@ -479,7 +479,7 @@ public class FastByteArrayOutputStream extends OutputStream {
/**
* Update the message digest with the next len bytes in this stream.
* Avoids creating new byte arrays and use internal buffers for performance.
* @param messageDigest The message digest to update
* @param messageDigest the message digest to update
* @param len how many bytes to read from this stream and use to update the message digest
*/
@Override

5
spring-core/src/main/java/org/springframework/util/FileCopyUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -43,6 +43,9 @@ import org.springframework.lang.Nullable;
*/
public abstract class FileCopyUtils {
/**
* The default buffer size used when copying bytes.
*/
public static final int BUFFER_SIZE = StreamUtils.BUFFER_SIZE;

3
spring-core/src/main/java/org/springframework/util/InstanceFilter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -30,6 +30,7 @@ import org.springframework.lang.Nullable;
*
* @author Stephane Nicoll
* @since 4.1
* @param <T> the instance type
*/
public class InstanceFilter<T> {

1
spring-core/src/main/java/org/springframework/util/LinkedCaseInsensitiveMap.java
View File

@@ -38,6 +38,7 @@ import org.springframework.lang.Nullable;
*
* @author Juergen Hoeller
* @since 3.0
* @param <V> the value type
*/
@SuppressWarnings("serial")
public class LinkedCaseInsensitiveMap<V> implements Map<String, V>, Serializable, Cloneable {

6
spring-core/src/main/java/org/springframework/util/LinkedMultiValueMap.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -36,6 +36,8 @@ import org.springframework.lang.Nullable;
* @author Arjen Poutsma
* @author Juergen Hoeller
* @since 3.0
* @param <K> the key type
* @param <V> the value element type
*/
public class LinkedMultiValueMap<K, V> implements MultiValueMap<K, V>, Serializable, Cloneable {
@@ -117,7 +119,7 @@ public class LinkedMultiValueMap<K, V> implements MultiValueMap<K, V>, Serializa
public Map<K, V> toSingleValueMap() {
LinkedHashMap<K, V> singleValueMap = new LinkedHashMap<>(this.targetMap.size());
this.targetMap.forEach((key, value) -> singleValueMap.put(key, value.get(0)));
return singleValueMap;
}

4
spring-core/src/main/java/org/springframework/util/MethodInvoker.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -53,7 +53,7 @@ public class MethodInvoker {
@Nullable
private Object[] arguments;
/** The method we will call */
/** The method we will call. */
@Nullable
private Method methodObject;

7
spring-core/src/main/java/org/springframework/util/MimeType.java
View File

@@ -401,7 +401,7 @@ public class MimeType implements Comparable<MimeType>, Serializable {
/**
* Determine if the parameters in this {@code MimeType} and the supplied
* {@code MimeType} are equal, performing case-insensitive comparisons
* for {@link Charset}s.
* for {@link Charset Charsets}.
* @since 4.2
*/
private boolean parametersAreEqual(MimeType other) {
@@ -542,6 +542,11 @@ public class MimeType implements Comparable<MimeType>, Serializable {
}
/**
* Comparator to sort {@link MimeType MimeTypes} in order of specificity.
*
* @param <T> the type of mime types that may be compared by this comparator
*/
public static class SpecificityComparator<T extends MimeType> implements Comparator<T> {
@Override

4
spring-core/src/main/java/org/springframework/util/MultiValueMap.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,6 +26,8 @@ import org.springframework.lang.Nullable;
*
* @author Arjen Poutsma
* @since 3.0
* @param <K> the key type
* @param <V> the value element type
*/
public interface MultiValueMap<K, V> extends Map<K, List<V>> {

4
spring-core/src/main/java/org/springframework/util/ReflectionUtils.java
View File

@@ -511,8 +511,8 @@ public abstract class ReflectionUtils {
* on Java 8 based interfaces that the given class implements).
* @param clazz the class to introspect
* @param mc the callback to invoke for each method
* @since 4.2
* @throws IllegalStateException if introspection fails
* @since 4.2
* @see #doWithMethods
*/
public static void doWithLocalMethods(Class<?> clazz, MethodCallback mc) {
@@ -682,8 +682,8 @@ public abstract class ReflectionUtils {
* Invoke the given callback on all locally declared fields in the given class.
* @param clazz the target class to analyze
* @param fc the callback to invoke for each field
* @since 4.2
* @throws IllegalStateException if introspection fails
* @since 4.2
* @see #doWithFields
*/
public static void doWithLocalFields(Class<?> clazz, FieldCallback fc) {

32
spring-core/src/main/java/org/springframework/util/ResourceUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -47,49 +47,49 @@ import org.springframework.lang.Nullable;
*/
public abstract class ResourceUtils {
/** Pseudo URL prefix for loading from the class path: "classpath:" */
/** Pseudo URL prefix for loading from the class path: "classpath:". */
public static final String CLASSPATH_URL_PREFIX = "classpath:";
/** URL prefix for loading from the file system: "file:" */
/** URL prefix for loading from the file system: "file:". */
public static final String FILE_URL_PREFIX = "file:";
/** URL prefix for loading from a jar file: "jar:" */
/** URL prefix for loading from a jar file: "jar:". */
public static final String JAR_URL_PREFIX = "jar:";
/** URL prefix for loading from a war file on Tomcat: "war:" */
/** URL prefix for loading from a war file on Tomcat: "war:". */
public static final String WAR_URL_PREFIX = "war:";
/** URL protocol for a file in the file system: "file" */
/** URL protocol for a file in the file system: "file". */
public static final String URL_PROTOCOL_FILE = "file";
/** URL protocol for an entry from a jar file: "jar" */
/** URL protocol for an entry from a jar file: "jar". */
public static final String URL_PROTOCOL_JAR = "jar";
/** URL protocol for an entry from a war file: "war" */
/** URL protocol for an entry from a war file: "war". */
public static final String URL_PROTOCOL_WAR = "war";
/** URL protocol for an entry from a zip file: "zip" */
/** URL protocol for an entry from a zip file: "zip". */
public static final String URL_PROTOCOL_ZIP = "zip";
/** URL protocol for an entry from a WebSphere jar file: "wsjar" */
/** URL protocol for an entry from a WebSphere jar file: "wsjar". */
public static final String URL_PROTOCOL_WSJAR = "wsjar";
/** URL protocol for an entry from a JBoss jar file: "vfszip" */
/** URL protocol for an entry from a JBoss jar file: "vfszip". */
public static final String URL_PROTOCOL_VFSZIP = "vfszip";
/** URL protocol for a JBoss file system resource: "vfsfile" */
/** URL protocol for a JBoss file system resource: "vfsfile". */
public static final String URL_PROTOCOL_VFSFILE = "vfsfile";
/** URL protocol for a general JBoss VFS resource: "vfs" */
/** URL protocol for a general JBoss VFS resource: "vfs". */
public static final String URL_PROTOCOL_VFS = "vfs";
/** File extension for a regular jar file: ".jar" */
/** File extension for a regular jar file: ".jar". */
public static final String JAR_FILE_EXTENSION = ".jar";
/** Separator between JAR URL and file path within the JAR: "!/" */
/** Separator between JAR URL and file path within the JAR: "!/". */
public static final String JAR_URL_SEPARATOR = "!/";
/** Special separator between WAR URL and jar part on Tomcat */
/** Special separator between WAR URL and jar part on Tomcat. */
public static final String WAR_URL_SEPARATOR = "*/";

6
spring-core/src/main/java/org/springframework/util/StopWatch.java
View File

@@ -53,10 +53,10 @@ public class StopWatch {
private final List<TaskInfo> taskList = new LinkedList<>();
/** Start time of the current task */
/** Start time of the current task. */
private long startTimeMillis;
/** Name of the current task */
/** Name of the current task. */
@Nullable
private String currentTaskName;
@@ -65,7 +65,7 @@ public class StopWatch {
private int taskCount;
/** Total running time */
/** Total running time. */
private long totalTimeMillis;

5
spring-core/src/main/java/org/springframework/util/StreamUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -45,6 +45,9 @@ import org.springframework.lang.Nullable;
*/
public abstract class StreamUtils {
/**
* The default buffer size used why copying bytes.
*/
public static final int BUFFER_SIZE = 4096;
private static final byte[] EMPTY_CONTENT = new byte[0];

12
spring-core/src/main/java/org/springframework/util/SystemPropertyUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2018 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.
@@ -35,13 +35,13 @@ import org.springframework.lang.Nullable;
*/
public abstract class SystemPropertyUtils {
/** Prefix for system property placeholders: "${" */
/** Prefix for system property placeholders: "${". */
public static final String PLACEHOLDER_PREFIX = "${";
/** Suffix for system property placeholders: "}" */
/** Suffix for system property placeholders: "}". */
public static final String PLACEHOLDER_SUFFIX = "}";
/** Value separator for system property placeholders: ":" */
/** Value separator for system property placeholders: ":". */
public static final String VALUE_SEPARATOR = ":";
@@ -57,9 +57,9 @@ public abstract class SystemPropertyUtils {
* corresponding system property values.
* @param text the String to resolve
* @return the resolved String
* @throws IllegalArgumentException if there is an unresolvable placeholder
* @see #PLACEHOLDER_PREFIX
* @see #PLACEHOLDER_SUFFIX
* @throws IllegalArgumentException if there is an unresolvable placeholder
*/
public static String resolvePlaceholders(String text) {
return resolvePlaceholders(text, false);
@@ -72,9 +72,9 @@ public abstract class SystemPropertyUtils {
* @param text the String to resolve
* @param ignoreUnresolvablePlaceholders whether unresolved placeholders are to be ignored
* @return the resolved String
* @throws IllegalArgumentException if there is an unresolvable placeholder
* @see #PLACEHOLDER_PREFIX
* @see #PLACEHOLDER_SUFFIX
* @throws IllegalArgumentException if there is an unresolvable placeholder
* and the "ignoreUnresolvablePlaceholders" flag is {@code false}
*/
public static String resolvePlaceholders(String text, boolean ignoreUnresolvablePlaceholders) {

5
spring-core/src/main/java/org/springframework/util/comparator/ComparableComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -25,12 +25,13 @@ import java.util.Comparator;
*
* @author Keith Donald
* @since 1.2.2
* @param <T> the type of comparable objects that may be compared by this comparator
* @see Comparable
*/
public class ComparableComparator<T extends Comparable<T>> implements Comparator<T> {
/**
* A shared instance of this default comparator
* A shared instance of this default comparator.
* @see Comparators#comparable()
*/
@SuppressWarnings("rawtypes")

3
spring-core/src/main/java/org/springframework/util/comparator/CompoundComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -36,6 +36,7 @@ import org.springframework.util.Assert;
* @author Keith Donald
* @author Juergen Hoeller
* @since 1.2.2
* @param <T> the type of objects that may be compared by this comparator
* @deprecated as of Spring Framework 5.0, in favor of the standard JDK 8
* {@link Comparator#thenComparing(Comparator)}
*/

4
spring-core/src/main/java/org/springframework/util/comparator/InstanceComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -33,8 +33,8 @@ import org.springframework.util.Assert;
*
* @author Phillip Webb
* @since 3.2
* @param <T> the type of objects that may be compared by this comparator
* @see Comparator#thenComparing(Comparator)
* @param <T> the type of objects being compared
*/
public class InstanceComparator<T> implements Comparator<T> {

3
spring-core/src/main/java/org/springframework/util/comparator/InvertibleComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -29,6 +29,7 @@ import org.springframework.util.Assert;
* @author Keith Donald
* @author Juergen Hoeller
* @since 1.2.2
* @param <T> the type of objects that may be compared by this comparator
* @deprecated as of Spring Framework 5.0, in favor of the standard JDK 8
* {@link Comparator#reversed()}
*/

3
spring-core/src/main/java/org/springframework/util/comparator/NullSafeComparator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,6 +28,7 @@ import org.springframework.util.Assert;
* @author Keith Donald
* @author Juergen Hoeller
* @since 1.2.2
* @param <T> the type of objects that may be compared by this comparator
* @see Comparable
*/
public class NullSafeComparator<T> implements Comparator<T> {

1
spring-core/src/main/java/org/springframework/util/concurrent/CompletableToListenableFutureAdapter.java
View File

@@ -29,6 +29,7 @@ import java.util.concurrent.TimeoutException;
* @author Sebastien Deleuze
* @author Juergen Hoeller
* @since 4.2
* @param <T> the result type returned by this Future's {@code get} method
*/
public class CompletableToListenableFutureAdapter<T> implements ListenableFuture<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/DelegatingCompletableFuture.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -27,6 +27,7 @@ import org.springframework.util.Assert;
*
* @author Juergen Hoeller
* @since 5.0
* @param <T> the result type returned by this Future's {@code get} method
*/
class DelegatingCompletableFuture<T> extends CompletableFuture<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/ListenableFuture.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -30,6 +30,7 @@ import java.util.concurrent.Future;
* @author Sebastien Deleuze
* @author Juergen Hoeller
* @since 4.0
* @param <T> the result type returned by this Future's {@code get} method
*/
public interface ListenableFuture<T> extends Future<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/ListenableFutureCallback.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -23,6 +23,7 @@ package org.springframework.util.concurrent;
* @author Arjen Poutsma
* @author Sebastien Deleuze
* @since 4.0
* @param <T> the result type
*/
public interface ListenableFutureCallback<T> extends SuccessCallback<T>, FailureCallback {

1
spring-core/src/main/java/org/springframework/util/concurrent/ListenableFutureCallbackRegistry.java
View File

@@ -32,6 +32,7 @@ import org.springframework.util.Assert;
* @author Sebastien Deleuze
* @author Rossen Stoyanchev
* @since 4.0
* @param <T> the callback result type
*/
public class ListenableFutureCallbackRegistry<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/ListenableFutureTask.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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,6 +28,7 @@ import org.springframework.lang.Nullable;
*
* @author Arjen Poutsma
* @since 4.0
* @param <T> the result type returned by this Future's {@code get} method
*/
public class ListenableFutureTask<T> extends FutureTask<T> implements ListenableFuture<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/SettableListenableFuture.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -35,6 +35,7 @@ import org.springframework.util.Assert;
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.1
* @param <T> the result type returned by this Future's {@code get} method
*/
public class SettableListenableFuture<T> implements ListenableFuture<T> {

3
spring-core/src/main/java/org/springframework/util/concurrent/SuccessCallback.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -23,6 +23,7 @@ import org.springframework.lang.Nullable;
*
* @author Sebastien Deleuze
* @since 4.1
* @param <T> the result type
*/
@FunctionalInterface
public interface SuccessCallback<T> {

2
spring-core/src/main/java/org/springframework/util/xml/AbstractStaxXMLReader.java
View File

@@ -147,7 +147,7 @@ abstract class AbstractStaxXMLReader extends AbstractXMLReader {
* Parse the StAX XML reader passed at construction-time.
* <p><b>NOTE:</b>: The given system identifier is not read, but ignored.
* @param ignored is ignored
* @throws SAXException A SAX exception, possibly wrapping a {@code XMLStreamException}
* @throws SAXException a SAX exception, possibly wrapping a {@code XMLStreamException}
*/
@Override
public final void parse(String ignored) throws SAXException {

4
spring-core/src/main/java/org/springframework/util/xml/DomContentHandler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -35,8 +35,8 @@ import org.springframework.util.Assert;
* SAX {@code ContentHandler} that transforms callback calls to DOM {@code Node}s.
*
* @author Arjen Poutsma
* @see org.w3c.dom.Node
* @since 3.0
* @see org.w3c.dom.Node
*/
class DomContentHandler implements ContentHandler {

4
spring-core/src/main/java/org/springframework/util/xml/DomUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -119,7 +119,7 @@ public abstract class DomUtils {
}
/**
* Retrieves all child elements of the given DOM element
* Retrieves all child elements of the given DOM element.
* @param ele the DOM element to analyze
* @return a List of child {@code org.w3c.dom.Element} instances
*/

4
spring-core/src/main/java/org/springframework/util/xml/ListBasedXMLEventReader.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@@ -25,7 +25,7 @@ import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Implementation of {@code XMLEventReader} based on a list of {@link XMLEvent}s.
* Implementation of {@code XMLEventReader} based on a list of {@link XMLEvent XMLEvents}.
*
* @author Arjen Poutsma
* @since 5.0

4
spring-core/src/main/java/org/springframework/util/xml/StaxSource.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -37,7 +37,7 @@ import org.springframework.lang.Nullable;
* {@code SAXSource} is <strong>not supported</strong>. In general, the only supported operation
* on this class is to use the {@code XMLReader} obtained via {@link #getXMLReader()} to parse the
* input source obtained via {@link #getInputSource()}. Calling {@link #setXMLReader(XMLReader)}
* or {@link #setInputSource(InputSource)} will result in {@code UnsupportedOperationException}s.
* or {@link #setInputSource(InputSource)} will result in {@code UnsupportedOperationException #setInputSource(InputSource)} will result in {@code UnsupportedOperationExceptions}.
*
* @author Arjen Poutsma
* @since 3.0

4
spring-core/src/main/java/org/springframework/util/xml/StaxUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -243,7 +243,7 @@ public abstract class StaxUtils {
/**
* Create a {@link XMLEventReader} from the given list of {@link XMLEvent}.
* @param events the list of {@link XMLEvent}s.
* @param events the list of {@link XMLEvent XMLEvents}.
* @return an {@code XMLEventReader} that reads from the given events
* @since 5.0
*/