Fix checkstyle javadoc issues
Fix checkstyle issues in javadoc following the spring-javaformat upgrade. See gh-13932
This commit is contained in:
parent
7fc455654a
commit
e6a68b39a3
|
|
@ -36,7 +36,7 @@ import org.springframework.util.Assert;
|
|||
* {@link EndpointFilter} that will filter endpoints based on {@code include} and
|
||||
* {@code exclude} properties.
|
||||
*
|
||||
* @param <E> The endpoint type
|
||||
* @param <E> the endpoint type
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import io.micrometer.core.instrument.MeterRegistry;
|
|||
* the registry.
|
||||
*
|
||||
* @author Jon Schneider
|
||||
* @param <T> The registry type to customize
|
||||
* @param <T> the registry type to customize
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import org.springframework.util.Assert;
|
|||
/**
|
||||
* Base class for properties to config adapters.
|
||||
*
|
||||
* @param <T> The properties type
|
||||
* @param <T> the properties type
|
||||
* @author Phillip Webb
|
||||
* @author Nikolay Rybak
|
||||
* @since 2.0.0
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import io.micrometer.core.instrument.step.StepRegistryConfig;
|
|||
/**
|
||||
* Base class for {@link StepRegistryProperties} to {@link StepRegistryConfig} adapters.
|
||||
*
|
||||
* @param <T> The properties type
|
||||
* @param <T> the properties type
|
||||
* @author Jon Schneider
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
|
|
|
|||
|
|
@ -55,9 +55,9 @@ public class AuditEvent implements Serializable {
|
|||
|
||||
/**
|
||||
* Create a new audit event for the current time.
|
||||
* @param principal The user principal responsible
|
||||
* @param principal the user principal responsible
|
||||
* @param type the event type
|
||||
* @param data The event data
|
||||
* @param data the event data
|
||||
*/
|
||||
public AuditEvent(String principal, String type, Map<String, Object> data) {
|
||||
this(Instant.now(), principal, type, data);
|
||||
|
|
@ -66,9 +66,9 @@ public class AuditEvent implements Serializable {
|
|||
/**
|
||||
* Create a new audit event for the current time from data provided as name-value
|
||||
* pairs.
|
||||
* @param principal The user principal responsible
|
||||
* @param principal the user principal responsible
|
||||
* @param type the event type
|
||||
* @param data The event data in the form 'key=value' or simply 'key'
|
||||
* @param data the event data in the form 'key=value' or simply 'key'
|
||||
*/
|
||||
public AuditEvent(String principal, String type, String... data) {
|
||||
this(Instant.now(), principal, type, convert(data));
|
||||
|
|
@ -76,10 +76,10 @@ public class AuditEvent implements Serializable {
|
|||
|
||||
/**
|
||||
* Create a new audit event.
|
||||
* @param timestamp The date/time of the event
|
||||
* @param principal The user principal responsible
|
||||
* @param timestamp the date/time of the event
|
||||
* @param principal the user principal responsible
|
||||
* @param type the event type
|
||||
* @param data The event data
|
||||
* @param data the event data
|
||||
*/
|
||||
public AuditEvent(Instant timestamp, String principal, String type,
|
||||
Map<String, Object> data) {
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.springframework.util.Assert;
|
|||
/**
|
||||
* Abstract base class for {@link ExposableEndpoint} implementations.
|
||||
*
|
||||
* @param <O> The operation type.
|
||||
* @param <O> the operation type.
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import org.springframework.util.Assert;
|
|||
* Abstract base class for {@link ExposableEndpoint endpoints} discovered by a
|
||||
* {@link EndpointDiscoverer}.
|
||||
*
|
||||
* @param <O> The operation type
|
||||
* @param <O> the operation type
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ import org.springframework.boot.actuate.endpoint.Operation;
|
|||
/**
|
||||
* An {@link ExposableEndpoint endpoint} discovered by an {@link EndpointDiscoverer}.
|
||||
*
|
||||
* @param <O> The operation type
|
||||
* @param <O> the operation type
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import org.springframework.core.annotation.AnnotationAttributes;
|
|||
* Factory to create an {@link Operation} for annotated methods on an
|
||||
* {@link Endpoint @Endpoint} or {@link EndpointExtension @EndpointExtension}.
|
||||
*
|
||||
* @param <O> The operation type
|
||||
* @param <O> the operation type
|
||||
* @author Andy Wilkinson
|
||||
* @author Stephane Nicoll
|
||||
* @author Phillip Webb
|
||||
|
|
|
|||
|
|
@ -54,8 +54,8 @@ import org.springframework.util.StringUtils;
|
|||
* {@link Endpoint @Endpoint} beans and {@link EndpointExtension @EndpointExtension} beans
|
||||
* in an application context.
|
||||
*
|
||||
* @param <E> The endpoint type
|
||||
* @param <O> The operation type
|
||||
* @param <E> the endpoint type
|
||||
* @param <O> the operation type
|
||||
* @author Andy Wilkinson
|
||||
* @author Stephane Nicoll
|
||||
* @author Phillip Webb
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import org.springframework.cache.Cache;
|
|||
/**
|
||||
* Provide a {@link MeterBinder} based on a {@link Cache}.
|
||||
*
|
||||
* @param <C> The cache type
|
||||
* @param <C> the cache type
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -69,8 +69,8 @@ public class RouterFunctionMetrics {
|
|||
/**
|
||||
* Returns a new {@link RouterFunctionMetrics} instance with the specified default
|
||||
* tags.
|
||||
* @param defaultTags Generate a list of tags to apply to the timer.
|
||||
* {@code ServerResponse} may be null.
|
||||
* @param defaultTags function to generate a list of tags to apply to the timer
|
||||
* {@code ServerResponse} may be null
|
||||
* @return {@code this} for further configuration
|
||||
*/
|
||||
public RouterFunctionMetrics defaultTags(
|
||||
|
|
@ -94,8 +94,8 @@ public class RouterFunctionMetrics {
|
|||
|
||||
/**
|
||||
* Creates a {@code method} tag from the method of the given {@code request}.
|
||||
* @param request The HTTP request.
|
||||
* @return A "method" tag whose value is a capitalized method (e.g. GET).
|
||||
* @param request the HTTP request
|
||||
* @return a "method" tag whose value is a capitalized method (e.g. GET)
|
||||
*/
|
||||
public static Tag getMethodTag(ServerRequest request) {
|
||||
return Tag.of("method", request.method().toString());
|
||||
|
|
@ -103,8 +103,8 @@ public class RouterFunctionMetrics {
|
|||
|
||||
/**
|
||||
* Creates a {@code status} tag from the status of the given {@code response}.
|
||||
* @param response The HTTP response.
|
||||
* @return A "status" tag whose value is the numeric status code.
|
||||
* @param response the HTTP response
|
||||
* @return a "status" tag whose value is the numeric status code
|
||||
*/
|
||||
public static Tag getStatusTag(ServerResponse response) {
|
||||
return Tag.of("status", response.statusCode().toString());
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,7 +23,7 @@ import org.springframework.transaction.PlatformTransactionManager;
|
|||
* {@link PlatformTransactionManager PlatformTransactionManagers} whilst retaining default
|
||||
* auto-configuration.
|
||||
*
|
||||
* @param <T> The transaction manager type
|
||||
* @param <T> the transaction manager type
|
||||
* @author Phillip Webb
|
||||
* @since 1.5.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -51,9 +51,9 @@ public class SpringApplicationLauncher {
|
|||
/**
|
||||
* Launches the application created using the given {@code sources}. The application
|
||||
* is launched with the given {@code args}.
|
||||
* @param sources The sources for the application
|
||||
* @param args The args for the application
|
||||
* @return The application's {@code ApplicationContext}
|
||||
* @param sources the sources for the application
|
||||
* @param args the args for the application
|
||||
* @return the application's {@code ApplicationContext}
|
||||
* @throws Exception if the launch fails
|
||||
*/
|
||||
public Object launch(Class<?>[] sources, String[] args) throws Exception {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,7 +30,7 @@ public interface CommandFactory {
|
|||
|
||||
/**
|
||||
* Returns the CLI {@link Command}s.
|
||||
* @return The commands
|
||||
* @return the commands
|
||||
*/
|
||||
Collection<Command> getCommands();
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,7 +30,7 @@ public class HelpExample {
|
|||
|
||||
/**
|
||||
* Create a new {@link HelpExample} instance.
|
||||
* @param description The description (in the form "to ....")
|
||||
* @param description the description (in the form "to ....")
|
||||
* @param example the example
|
||||
*/
|
||||
public HelpExample(String description, String example) {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -32,8 +32,8 @@ interface DependencyResolver {
|
|||
/**
|
||||
* Resolves the given {@code artifactIdentifiers}, typically in the form
|
||||
* "group:artifact:version", and their dependencies.
|
||||
* @param artifactIdentifiers The artifacts to resolve
|
||||
* @return The {@code File}s for the resolved artifacts
|
||||
* @param artifactIdentifiers the artifacts to resolve
|
||||
* @return the {@code File}s for the resolved artifacts
|
||||
* @throws Exception if dependency resolution fails
|
||||
*/
|
||||
List<File> resolve(List<String> artifactIdentifiers) throws Exception;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -185,7 +185,7 @@ public class DependencyCustomizer {
|
|||
* Add dependencies and all of their dependencies. The group ID and version of the
|
||||
* dependencies are resolved from the modules using the customizer's
|
||||
* {@link ArtifactCoordinatesResolver}.
|
||||
* @param modules The module IDs
|
||||
* @param modules the module IDs
|
||||
* @return this {@link DependencyCustomizer} for continued use
|
||||
*/
|
||||
public DependencyCustomizer add(String... modules) {
|
||||
|
|
@ -199,9 +199,9 @@ public class DependencyCustomizer {
|
|||
* Add a single dependency and, optionally, all of its dependencies. The group ID and
|
||||
* version of the dependency are resolved from the module using the customizer's
|
||||
* {@link ArtifactCoordinatesResolver}.
|
||||
* @param module The module ID
|
||||
* @param module the module ID
|
||||
* @param transitive {@code true} if the transitive dependencies should also be added,
|
||||
* otherwise {@code false}.
|
||||
* otherwise {@code false}
|
||||
* @return this {@link DependencyCustomizer} for continued use
|
||||
*/
|
||||
public DependencyCustomizer add(String module, boolean transitive) {
|
||||
|
|
@ -212,11 +212,11 @@ public class DependencyCustomizer {
|
|||
* Add a single dependency with the specified classifier and type and, optionally, all
|
||||
* of its dependencies. The group ID and version of the dependency are resolved from
|
||||
* the module by using the customizer's {@link ArtifactCoordinatesResolver}.
|
||||
* @param module The module ID
|
||||
* @param classifier The classifier, may be {@code null}
|
||||
* @param type The type, may be {@code null}
|
||||
* @param module the module ID
|
||||
* @param classifier the classifier, may be {@code null}
|
||||
* @param type the type, may be {@code null}
|
||||
* @param transitive {@code true} if the transitive dependencies should also be added,
|
||||
* otherwise {@code false}.
|
||||
* otherwise {@code false}
|
||||
* @return this {@link DependencyCustomizer} for continued use
|
||||
*/
|
||||
public DependencyCustomizer add(String module, String classifier, String type,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,24 +31,24 @@ public interface ArtifactCoordinatesResolver {
|
|||
/**
|
||||
* Gets the group id of the artifact identified by the given {@code module}. Returns
|
||||
* {@code null} if the artifact is unknown to the resolver.
|
||||
* @param module The id of the module
|
||||
* @return The group id of the module
|
||||
* @param module the id of the module
|
||||
* @return the group id of the module
|
||||
*/
|
||||
String getGroupId(String module);
|
||||
|
||||
/**
|
||||
* Gets the artifact id of the artifact identified by the given {@code module}.
|
||||
* Returns {@code null} if the artifact is unknown to the resolver.
|
||||
* @param module The id of the module
|
||||
* @return The artifact id of the module
|
||||
* @param module the id of the module
|
||||
* @return the artifact id of the module
|
||||
*/
|
||||
String getArtifactId(String module);
|
||||
|
||||
/**
|
||||
* Gets the version of the artifact identified by the given {@code module}. Returns
|
||||
* {@code null} if the artifact is unknown to the resolver.
|
||||
* @param module The id of the module
|
||||
* @return The version of the module
|
||||
* @param module the id of the module
|
||||
* @return the version of the module
|
||||
*/
|
||||
String getVersion(String module);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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 @@ public interface DependencyManagement {
|
|||
|
||||
/**
|
||||
* Finds the managed dependency with the given {@code artifactId}.
|
||||
* @param artifactId The artifact ID of the dependency to find
|
||||
* @param artifactId the artifact ID of the dependency to find
|
||||
* @return the dependency, or {@code null}
|
||||
*/
|
||||
Dependency find(String artifactId);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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 @@ public class DependencyResolutionFailedException extends RuntimeException {
|
|||
/**
|
||||
* Creates a new {@code DependencyResolutionFailedException} with the given
|
||||
* {@code cause}.
|
||||
* @param cause The cause of the resolution failure
|
||||
* @param cause the cause of the resolution failure
|
||||
*/
|
||||
public DependencyResolutionFailedException(Throwable cause) {
|
||||
super(cause);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,10 +30,10 @@ public interface TunnelConnection {
|
|||
|
||||
/**
|
||||
* Open the tunnel connection.
|
||||
* @param incomingChannel A {@link WritableByteChannel} that should be used to write
|
||||
* any incoming data received from the remote server.
|
||||
* @param incomingChannel a {@link WritableByteChannel} that should be used to write
|
||||
* any incoming data received from the remote server
|
||||
* @param closeable a closeable to call when the channel is closed
|
||||
* @return A {@link WritableByteChannel} that should be used to send any outgoing data
|
||||
* @return a {@link WritableByteChannel} that should be used to send any outgoing data
|
||||
* destined for the remote server
|
||||
* @throws Exception in case of errors
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ import static org.assertj.core.api.Assertions.assertThat;
|
|||
* AssertJ {@link org.assertj.core.api.Assert assertions} that can be applied to an
|
||||
* {@link ApplicationContext}.
|
||||
*
|
||||
* @param <C> The application context type
|
||||
* @param <C> the application context type
|
||||
* @author Phillip Webb
|
||||
* @author Andy Wilkinson
|
||||
* @since 2.0.0
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,7 +41,7 @@ import org.springframework.util.Assert;
|
|||
* Any {@link ApplicationContext} method called on a context that has failed to start will
|
||||
* throw an {@link IllegalStateException}.
|
||||
*
|
||||
* @param <C> The application context type
|
||||
* @param <C> the application context type
|
||||
* @author Phillip Webb
|
||||
* @see AssertableApplicationContext
|
||||
* @see AssertableWebApplicationContext
|
||||
|
|
|
|||
|
|
@ -84,9 +84,9 @@ import org.springframework.util.Assert;
|
|||
* }</pre>
|
||||
* <p>
|
||||
*
|
||||
* @param <SELF> The "self" type for this runner
|
||||
* @param <C> The context type
|
||||
* @param <A> The application context assertion provider
|
||||
* @param <SELF> the "self" type for this runner
|
||||
* @param <C> the context type
|
||||
* @param <A> the application context assertion provider
|
||||
* @author Stephane Nicoll
|
||||
* @author Andy Wilkinson
|
||||
* @author Phillip Webb
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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,7 +24,7 @@ import org.springframework.context.ApplicationContext;
|
|||
*
|
||||
* @author Stephane Nicoll
|
||||
* @author Andy Wilkinson
|
||||
* @param <C> The application context type
|
||||
* @param <C> the application context type
|
||||
* @since 2.0.0
|
||||
* @see AbstractApplicationContextRunner
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -352,7 +352,7 @@ public abstract class AbstractJsonMarshalTester<T> {
|
|||
* Utility class used to support field initialization. Used by subclasses to support
|
||||
* {@code initFields}.
|
||||
*
|
||||
* @param <M> The marshaller type
|
||||
* @param <M> the marshaller type
|
||||
*/
|
||||
protected abstract static class FieldInitializer<M> {
|
||||
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ public class BasicJsonTester {
|
|||
* Create JSON content from the specified String source. The source can contain the
|
||||
* JSON itself or, if it ends with {@code .json}, the name of a resource to be loaded
|
||||
* using {@code resourceLoadClass}.
|
||||
* @param source JSON content or a {@code .json} resource name
|
||||
* @param source the JSON content or a {@code .json} resource name
|
||||
* @return the JSON content
|
||||
*/
|
||||
public JsonContent<Object> from(CharSequence source) {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.assertj.core.internal.Objects;
|
|||
/**
|
||||
* AssertJ {@link Assert} for {@link ObjectContent}.
|
||||
*
|
||||
* @param <A> The actual type
|
||||
* @param <A> the actual type
|
||||
* @author Phillip Webb
|
||||
* @since 1.4.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -51,8 +51,8 @@ public class MetadataCollector {
|
|||
|
||||
/**
|
||||
* Creates a new {@code MetadataProcessor} instance.
|
||||
* @param processingEnvironment The processing environment of the build
|
||||
* @param previousMetadata Any previous metadata or {@code null}
|
||||
* @param processingEnvironment the processing environment of the build
|
||||
* @param previousMetadata any previous metadata or {@code null}
|
||||
*/
|
||||
public MetadataCollector(ProcessingEnvironment processingEnvironment,
|
||||
ConfigurationMetadata previousMetadata) {
|
||||
|
|
|
|||
|
|
@ -160,8 +160,8 @@ public class JarWriter implements LoaderClassesWriter, AutoCloseable {
|
|||
|
||||
/**
|
||||
* Writes an entry. The {@code inputStream} is closed once the entry has been written
|
||||
* @param entryName The name of the entry
|
||||
* @param inputStream The stream from which the entry's data can be read
|
||||
* @param entryName the name of the entry
|
||||
* @param inputStream the stream from which the entry's data can be read
|
||||
* @throws IOException if the write fails
|
||||
*/
|
||||
@Override
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ class CentralDirectoryParser {
|
|||
* Parse the source data, triggering {@link CentralDirectoryVisitor visitors}.
|
||||
* @param data the source data
|
||||
* @param skipPrefixBytes if prefix bytes should be skipped
|
||||
* @return The actual archive data without any prefix bytes
|
||||
* @return the actual archive data without any prefix bytes
|
||||
* @throws IOException on error
|
||||
*/
|
||||
public RandomAccessData parse(RandomAccessData data, boolean skipPrefixBytes)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -65,8 +65,8 @@ final class EnvironmentConverter {
|
|||
* environment is already a {@code StandardEnvironment} and is not a
|
||||
* {@link ConfigurableWebEnvironment} no conversion is performed and it is returned
|
||||
* unchanged.
|
||||
* @param environment The Environment to convert
|
||||
* @return The converted Environment
|
||||
* @param environment the Environment to convert
|
||||
* @return the converted Environment
|
||||
*/
|
||||
StandardEnvironment convertToStandardEnvironmentIfNecessary(
|
||||
ConfigurableEnvironment environment) {
|
||||
|
|
|
|||
|
|
@ -1001,7 +1001,7 @@ public class SpringApplication {
|
|||
/**
|
||||
* Sets the {@link Banner} instance which will be used to print the banner when no
|
||||
* static banner file is provided.
|
||||
* @param banner The Banner instance to use
|
||||
* @param banner the Banner instance to use
|
||||
*/
|
||||
public void setBanner(Banner banner) {
|
||||
this.banner = banner;
|
||||
|
|
|
|||
|
|
@ -94,8 +94,8 @@ public class SpringApplicationBuilder {
|
|||
* Creates a new {@link org.springframework.boot.SpringApplication} instances from the
|
||||
* given sources. Subclasses may override in order to provide a custom subclass of
|
||||
* {@link org.springframework.boot.SpringApplication}
|
||||
* @param sources The sources
|
||||
* @return The {@link org.springframework.boot.SpringApplication} instance
|
||||
* @param sources the sources
|
||||
* @return the {@link org.springframework.boot.SpringApplication} instance
|
||||
* @since 1.1.0
|
||||
*/
|
||||
protected SpringApplication createSpringApplication(Class<?>... sources) {
|
||||
|
|
@ -326,7 +326,7 @@ public class SpringApplicationBuilder {
|
|||
/**
|
||||
* Sets the {@link Banner} instance which will be used to print the banner when no
|
||||
* static banner file is provided.
|
||||
* @param banner The banner to use
|
||||
* @param banner the banner to use
|
||||
* @return the current builder
|
||||
*/
|
||||
public SpringApplicationBuilder banner(Banner banner) {
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ abstract class AggregateBinder<T> {
|
|||
/**
|
||||
* Internal class used to supply the aggregate and cache the value.
|
||||
*
|
||||
* @param <T> The aggregate type
|
||||
* @param <T> the aggregate type
|
||||
*/
|
||||
protected static class AggregateSupplier<T> {
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ interface BeanBinder {
|
|||
* @param target the bindable to bind
|
||||
* @param context the bind context
|
||||
* @param propertyBinder property binder
|
||||
* @param <T> The source type
|
||||
* @param <T> the source type
|
||||
* @return a bound instance or {@code null}
|
||||
*/
|
||||
<T> T bind(ConfigurationPropertyName name, Bindable<T> target, Context context,
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ import org.springframework.util.ObjectUtils;
|
|||
* A container object to return result of a {@link Binder} bind operation. May contain
|
||||
* either a successfully bound object or an empty result.
|
||||
*
|
||||
* @param <T> The result type
|
||||
* @param <T> the result type
|
||||
* @author Phillip Webb
|
||||
* @author Madhura Bhave
|
||||
* @since 2.0.0
|
||||
|
|
@ -81,7 +81,7 @@ public final class BindResult<T> {
|
|||
/**
|
||||
* Apply the provided mapping function to the bound value, or return an updated
|
||||
* unbound result if no value has been bound.
|
||||
* @param <U> The type of the result of the mapping function
|
||||
* @param <U> the type of the result of the mapping function
|
||||
* @param mapper a mapping function to apply to the bound value. The mapper will not
|
||||
* be invoked if no value has been bound.
|
||||
* @return an {@code BindResult} describing the result of applying a mapping function
|
||||
|
|
@ -127,8 +127,8 @@ public final class BindResult<T> {
|
|||
/**
|
||||
* Return the object that was bound, or throw an exception to be created by the
|
||||
* provided supplier if no value has been bound.
|
||||
* @param <X> Type of the exception to be thrown
|
||||
* @param exceptionSupplier The supplier which will return the exception to be thrown
|
||||
* @param <X> the type of the exception to be thrown
|
||||
* @param exceptionSupplier the supplier which will return the exception to be thrown
|
||||
* @return the present value
|
||||
* @throws X if there is no value present
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ import org.springframework.util.ObjectUtils;
|
|||
/**
|
||||
* Source that can be bound by a {@link Binder}.
|
||||
*
|
||||
* @param <T> The source type
|
||||
* @param <T> the source type
|
||||
* @author Phillip Webb
|
||||
* @author Madhura Bhave
|
||||
* @since 2.0.0
|
||||
|
|
@ -179,7 +179,7 @@ public final class Bindable<T> {
|
|||
/**
|
||||
* Create a new {@link Bindable} of the type of the specified instance with an
|
||||
* existing value equal to the instance.
|
||||
* @param <T> The source type
|
||||
* @param <T> the source type
|
||||
* @param instance the instance (must not be {@code null})
|
||||
* @return a {@link Bindable} instance
|
||||
* @see #of(ResolvableType)
|
||||
|
|
@ -194,7 +194,7 @@ public final class Bindable<T> {
|
|||
|
||||
/**
|
||||
* Create a new {@link Bindable} of the specified type.
|
||||
* @param <T> The source type
|
||||
* @param <T> the source type
|
||||
* @param type the type (must not be {@code null})
|
||||
* @return a {@link Bindable} instance
|
||||
* @see #of(ResolvableType)
|
||||
|
|
@ -238,7 +238,7 @@ public final class Bindable<T> {
|
|||
|
||||
/**
|
||||
* Create a new {@link Bindable} of the specified type.
|
||||
* @param <T> The source type
|
||||
* @param <T> the source type
|
||||
* @param type the type (must not be {@code null})
|
||||
* @return a {@link Bindable} instance
|
||||
* @see #of(Class)
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ abstract class IndexedElementsBinder<T> extends AggregateBinder<T> {
|
|||
|
||||
/**
|
||||
* Bind indexed elements to the supplied collection.
|
||||
* @param name The name of the property to bind
|
||||
* @param name the name of the property to bind
|
||||
* @param target the target bindable
|
||||
* @param elementBinder the binder to use for elements
|
||||
* @param aggregateType the aggregate type, may be a collection or an array
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ public class SpringApplicationJsonEnvironmentPostProcessor
|
|||
|
||||
/**
|
||||
* Flatten the map keys using period separator.
|
||||
* @param map The map that should be flattened
|
||||
* @param map the map that should be flattened
|
||||
* @return the flattened map
|
||||
*/
|
||||
private Map<String, Object> flatten(Map<String, Object> map) {
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ public abstract class AbstractLoggingSystem extends LoggingSystem {
|
|||
/**
|
||||
* Maintains a mapping between native levels and {@link LogLevel}.
|
||||
*
|
||||
* @param <T> The native level type
|
||||
* @param <T> the native level type
|
||||
*/
|
||||
protected static class LogLevels<T> {
|
||||
|
||||
|
|
|
|||
|
|
@ -146,7 +146,7 @@ public abstract class LoggingSystem {
|
|||
/**
|
||||
* Detect and return the logging system in use. Supports Logback and Java Logging.
|
||||
* @param classLoader the classloader
|
||||
* @return The logging system
|
||||
* @return the logging system
|
||||
*/
|
||||
public static LoggingSystem get(ClassLoader classLoader) {
|
||||
String loggingSystem = System.getProperty(SYSTEM_PROPERTY);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -20,7 +20,7 @@ package org.springframework.boot.origin;
|
|||
* An interface that may be implemented by an object that can lookup {@link Origin}
|
||||
* information from a given key. Can be used to add origin support to existing classes.
|
||||
*
|
||||
* @param <K> The lookup key type
|
||||
* @param <K> the lookup key type
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ public class EntityManagerFactoryBuilder {
|
|||
* Create a new instance passing in the common pieces that will be shared if multiple
|
||||
* EntityManagerFactory instances are created.
|
||||
* @param jpaVendorAdapter a vendor adapter
|
||||
* @param jpaProperties JPA properties to be passed to the persistence provider.
|
||||
* @param jpaProperties the JPA properties to be passed to the persistence provider
|
||||
* @param persistenceUnitManager optional source of persistence unit information (can
|
||||
* be null)
|
||||
*/
|
||||
|
|
@ -74,7 +74,7 @@ public class EntityManagerFactoryBuilder {
|
|||
* Create a new instance passing in the common pieces that will be shared if multiple
|
||||
* EntityManagerFactory instances are created.
|
||||
* @param jpaVendorAdapter a vendor adapter
|
||||
* @param jpaProperties JPA properties to be passed to the persistence provider.
|
||||
* @param jpaProperties the JPA properties to be passed to the persistence provider
|
||||
* @param persistenceUnitManager optional source of persistence unit information (can
|
||||
* be null)
|
||||
* @param persistenceUnitRootLocation the persistence unit root location to use as a
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import org.springframework.web.server.ServerWebExchange;
|
|||
* {@link AutowireCapableBeanFactory#createBean(Class, int, boolean) create a new bean}
|
||||
* that is autowired in the usual way.
|
||||
*
|
||||
* @param <C> The type of the context that the match method actually needs to use. Can be
|
||||
* @param <C> the type of the context that the match method actually needs to use. Can be
|
||||
* an {@link ApplicationContext} or a class of an {@link ApplicationContext#getBean(Class)
|
||||
* existing bean}.
|
||||
* @author Madhura Bhave
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.springframework.web.context.support.WebApplicationContextUtils;
|
|||
* {@link AutowireCapableBeanFactory#createBean(Class, int, boolean) create a new bean}
|
||||
* that is autowired in the usual way.
|
||||
*
|
||||
* @param <C> The type of the context that the match method actually needs to use. Can be
|
||||
* @param <C> the type of the context that the match method actually needs to use. Can be
|
||||
* an {@link ApplicationContext} or a class of an {@link ApplicationContext#getBean(Class)
|
||||
* existing bean}.
|
||||
* @author Phillip Webb
|
||||
|
|
|
|||
|
|
@ -368,7 +368,7 @@ public final class LambdaSafe {
|
|||
* the callback wasn't suitable. Similar in design to {@link Optional} but allows for
|
||||
* {@code null} as a valid value.
|
||||
*
|
||||
* @param <R> The result type
|
||||
* @param <R> the result type
|
||||
*/
|
||||
public static final class InvocationResult<R> {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2017 the original author or authors.
|
||||
* Copyright 2012-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.
|
||||
|
|
@ -166,7 +166,7 @@ public abstract class AbstractConfigurableWebServerFactory
|
|||
/**
|
||||
* Return the absolute temp dir for given web server.
|
||||
* @param prefix server name
|
||||
* @return The temp dir for given server.
|
||||
* @return the temp dir for given server.
|
||||
*/
|
||||
protected final File createTempDir(String prefix) {
|
||||
try {
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ import org.springframework.beans.factory.config.BeanPostProcessor;
|
|||
* It might be safer to lookup dependencies lazily in the enclosing BeanFactory rather
|
||||
* than injecting them with {@code @Autowired}.
|
||||
*
|
||||
* @param <T> The configurable web server factory
|
||||
* @param <T> the configurable web server factory
|
||||
* @author Phillip Webb
|
||||
* @author Dave Syer
|
||||
* @author Brian Clozel
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.springframework.util.StringUtils;
|
|||
* Base class for Servlet 3.0+ {@link javax.servlet.Registration.Dynamic dynamic} based
|
||||
* registration beans.
|
||||
*
|
||||
* @param <D> The dynamic registration result
|
||||
* @param <D> the dynamic registration result
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue