From ccdbfd274f679776ca636abff43700ecabe1dbc2 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 2 Feb 2015 12:02:36 -0800 Subject: [PATCH] Fix Java 8 Javadoc compatibility Update Javadocs to fix errors caused by Java 8 aggressive linting. Fixes gh-2233 --- eclipse/org.eclipse.jdt.core.prefs | 4 +- .../boot/actuate/audit/AuditEvent.java | 6 +- .../audit/listener/AuditApplicationEvent.java | 12 +- .../ManagementServerProperties.java | 4 +- .../MetricRepositoryAutoConfiguration.java | 8 +- .../autoconfigure/ShellProperties.java | 5 +- .../actuate/endpoint/AbstractEndpoint.java | 3 +- ...ConfigurationPropertiesReportEndpoint.java | 6 +- .../boot/actuate/endpoint/Endpoint.java | 6 +- .../boot/actuate/endpoint/HealthEndpoint.java | 4 +- .../actuate/endpoint/SystemPublicMetrics.java | 7 +- .../endpoint/mvc/EndpointHandlerMapping.java | 8 +- .../actuate/endpoint/mvc/MvcEndpoint.java | 5 +- .../health/AbstractHealthAggregator.java | 4 +- .../health/CompositeHealthIndicator.java | 4 +- .../health/DataSourceHealthIndicator.java | 5 +- .../health/DiskSpaceHealthIndicator.java | 3 +- .../boot/actuate/health/Health.java | 7 +- .../boot/actuate/health/HealthAggregator.java | 4 +- .../boot/actuate/metrics/Metric.java | 6 +- .../util/SimpleInMemoryRepository.java | 3 +- .../boot/actuate/metrics/writer/Delta.java | 3 +- .../actuate/metrics/writer/MetricWriter.java | 4 +- .../metrics/writer/PrefixMetricWriter.java | 3 +- .../system/ApplicationPidFileWriter.java | 3 +- .../boot/actuate/trace/TraceRepository.java | 3 +- .../actuate/trace/WebRequestTraceFilter.java | 6 +- .../autoconfigure/AutoConfigureAfter.java | 3 +- .../autoconfigure/AutoConfigureBefore.java | 3 +- .../EnableAutoConfiguration.java | 3 +- .../autoconfigure/SpringBootApplication.java | 3 +- .../condition/AnyNestedCondition.java | 6 +- .../condition/BeanTypeRegistry.java | 4 +- .../condition/ConditionEvaluationReport.java | 4 +- .../condition/ConditionOutcome.java | 7 +- .../condition/ConditionalOnBean.java | 3 +- .../condition/ConditionalOnExpression.java | 3 +- .../condition/ConditionalOnJava.java | 5 +- .../condition/ConditionalOnJndi.java | 3 +- .../condition/ConditionalOnMissingBean.java | 3 +- .../condition/ConditionalOnProperty.java | 15 +- .../condition/SpringBootCondition.java | 5 +- ...tRepositoryConfigurationSourceSupport.java | 5 +- .../jdbc/DataSourceAutoConfiguration.java | 3 +- .../jdbc/EmbeddedDatabaseConnection.java | 5 +- .../AbstractDataSourcePoolMetadata.java | 4 +- .../jdbc/metadata/DataSourcePoolMetadata.java | 7 +- .../DataSourcePoolMetadataProvider.java | 4 +- .../DataSourcePoolMetadataProviders.java | 3 +- .../TomcatDataSourcePoolMetadata.java | 4 +- .../jms/hornetq/HornetQProperties.java | 3 +- .../orm/jpa/EntityManagerFactoryBuilder.java | 3 +- .../orm/jpa/JpaBaseConfiguration.java | 1 + .../AbstractViewResolverProperties.java | 4 +- .../TemplateAvailabilityProvider.java | 3 +- .../autoconfigure/web/ErrorController.java | 3 +- .../web/MultipartAutoConfiguration.java | 4 +- .../WebSocketContainerCustomizer.java | 3 +- spring-boot-docs/pom.xml | 288 +++++++++++++++++- .../boot/gradle/PluginFeatures.java | 6 +- .../boot/maven/DependencyFilter.java | 6 +- .../boot/maven/ExcludeFilter.java | 5 +- .../boot/maven/MatchingGroupIdFilter.java | 3 +- .../boot/json/JsonJsonParser.java | 4 +- 64 files changed, 489 insertions(+), 88 deletions(-) diff --git a/eclipse/org.eclipse.jdt.core.prefs b/eclipse/org.eclipse.jdt.core.prefs index 63d59166b3c..b25b4acfb08 100644 --- a/eclipse/org.eclipse.jdt.core.prefs +++ b/eclipse/org.eclipse.jdt.core.prefs @@ -52,10 +52,10 @@ org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag -org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled -org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=default org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled org.eclipse.jdt.core.compiler.problem.missingSerialVersion=ignore diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java index 55e468fcd87..1587f21ef86 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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. @@ -103,6 +103,7 @@ public class AuditEvent implements Serializable { /** * Returns the date/time that the even was logged. + * @return the time stamp */ public Date getTimestamp() { return this.timestamp; @@ -110,6 +111,7 @@ public class AuditEvent implements Serializable { /** * Returns the user principal responsible for the event or {@code null}. + * @return the principal or {@code null} */ public String getPrincipal() { return this.principal; @@ -117,6 +119,7 @@ public class AuditEvent implements Serializable { /** * Returns the type of event. + * @return the event type */ public String getType() { return this.type; @@ -124,6 +127,7 @@ public class AuditEvent implements Serializable { /** * Returns the event data. + * @return the event data */ public Map getData() { return this.data; diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java index 6e8d1fabb4c..94c8e2a25bf 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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,9 @@ public class AuditApplicationEvent extends ApplicationEvent { /** * Create a new {@link AuditApplicationEvent} that wraps a newly created * {@link AuditEvent}. + * @param principal the principal + * @param type the event type + * @param data the event data * @see AuditEvent#AuditEvent(String, String, Map) */ public AuditApplicationEvent(String principal, String type, Map data) { @@ -44,6 +47,9 @@ public class AuditApplicationEvent extends ApplicationEvent { /** * Create a new {@link AuditApplicationEvent} that wraps a newly created * {@link AuditEvent}. + * @param principal the principal + * @param type the event type + * @param data the event data * @see AuditEvent#AuditEvent(String, String, String...) */ public AuditApplicationEvent(String principal, String type, String... data) { @@ -53,6 +59,10 @@ public class AuditApplicationEvent extends ApplicationEvent { /** * Create a new {@link AuditApplicationEvent} that wraps a newly created * {@link AuditEvent}. + * @param timestamp the time stamp + * @param principal the principal + * @param type the event type + * @param data the event data * @see AuditEvent#AuditEvent(Date, String, String, Map) */ public AuditApplicationEvent(Date timestamp, String principal, String type, diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java index e65772feb90..5653d1f96bc 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -79,6 +79,7 @@ public class ManagementServerProperties implements SecurityPrerequisite { /** * Returns the management port or {@code null} if the * {@link ServerProperties#getPort() server port} should be used. + * @return the port * @see #setPort(Integer) */ public Integer getPort() { @@ -88,6 +89,7 @@ public class ManagementServerProperties implements SecurityPrerequisite { /** * Sets the port of the management server, use {@code null} if the * {@link ServerProperties#getPort() server port} should be used. To disable use 0. + * @param port the port */ public void setPort(Integer port) { this.port = port; diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java index 65cce8ade10..5e368ce9c05 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ import com.codahale.metrics.MetricRegistry; /** * {@link EnableAutoConfiguration Auto-configuration} for metrics services. Creates * user-facing {@link GaugeService} and {@link CounterService} instances, and also back - * end repositories to catch the data pumped into them.

+ * end repositories to catch the data pumped into them. *

* An {@link InMemoryMetricRepository} is always created unless another * {@link MetricRepository} is already provided by the user. In general, even if metric @@ -61,27 +61,23 @@ import com.codahale.metrics.MetricRegistry; * repository to buffer metric updates locally. The values can be exported (e.g. on a * periodic basis) using an {@link Exporter}, most implementations of which have * optimizations for sending data to remote repositories. - *

*

* If Spring Messaging is on the classpath a {@link MessageChannel} called * "metricsChannel" is also created (unless one already exists) and all metric update * events are published additionally as messages on that channel. Additional analysis or * actions can be taken by clients subscribing to that channel. - *

*

* In addition if Codahale's metrics library is on the classpath a {@link MetricRegistry} * will be created and wired up to the counter and gauge services in addition to the basic * repository. Users can create Codahale metrics by prefixing their metric names with the * appropriate type (e.g. "histogram.*", "meter.*") and sending them to the standard * GaugeService or CounterService. - *

*

* By default all metric updates go to all {@link MetricWriter} instances in the * application context. To change this behaviour define your own metric writer bean called * "primaryMetricWriter", mark it @Primary, and this one will receive all * updates from the default counter and gauge services. Alternatively you can provide your * own counter and gauge services and wire them to whichever writer you choose. - *

* * @see GaugeService * @see CounterService diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java index 957253dd4d8..f519e4f8195 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2014 the original author or authors. + * Copyright 2013-2015 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. @@ -153,6 +153,7 @@ public class ShellProperties { /** * Return a properties file configured from these settings that can be applied to a * CRaSH shell instance. + * @return the CRaSH properties */ public Properties asCrshShellConfig() { Properties properties = new Properties(); @@ -185,6 +186,7 @@ public class ShellProperties { /** * Basic validation of applied CRaSH shell configuration. + * @param properties the properties to validate */ protected void validateCrshShellConfig(Properties properties) { String finalAuth = properties.getProperty("crash.auth"); @@ -205,6 +207,7 @@ public class ShellProperties { /** * Apply the properties to a CRaSH configuration. + * @param config the CRaSH configuration properties */ protected abstract void applyToCrshShellConfig(Properties config); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AbstractEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AbstractEndpoint.java index 0cdf6ecff55..a7e4436b3a6 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AbstractEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AbstractEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 org.springframework.core.env.Environment; /** * Abstract base for {@link Endpoint} implementations. * + * @param the endpoint data type * @author Phillip Webb * @author Christian Dupuis */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java index f4599a71663..b1eb293dd7f 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2014 the original author or authors. + * Copyright 2013-2015 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. @@ -102,7 +102,6 @@ public class ConfigurationPropertiesReportEndpoint extends /** * Location path for JSON metadata about config properties. - * * @param metadataLocations the metadataLocations to set */ public void setMetadataLocations(String metadataLocations) { @@ -117,6 +116,8 @@ public class ConfigurationPropertiesReportEndpoint extends /** * Extract beans annotated {@link ConfigurationProperties} and serialize into * {@link Map}. + * @param context the application context + * @return the beans */ protected Map extract(ApplicationContext context) { // Serialize beans into map structure and sanitize values @@ -191,6 +192,7 @@ public class ConfigurationPropertiesReportEndpoint extends /** * Configure Jackson's {@link ObjectMapper} to be used to serialize the * {@link ConfigurationProperties} objects into a {@link Map} structure. + * @param mapper the object mapper */ protected void configureObjectMapper(ObjectMapper mapper) { mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Endpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Endpoint.java index e39c58d71ce..aa59b82a5d1 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Endpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Endpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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. @@ -21,6 +21,7 @@ package org.springframework.boot.actuate.endpoint; * exposed via Spring MVC but could also be exposed using some other technique. Consider * extending {@link AbstractEndpoint} if you are developing your own endpoint. * + * @param the endpoint data type * @author Phillip Webb * @author Dave Syer * @author Christian Dupuis @@ -31,17 +32,20 @@ public interface Endpoint { /** * The logical ID of the endpoint. Must only contain simple letters, numbers and '_' * characters (ie a {@literal "\w"} regex). + * @return the endpoint ID */ String getId(); /** * Return if the endpoint is enabled. + * @return if the endpoint is enabled */ boolean isEnabled(); /** * Return if the endpoint is sensitive, i.e. may return data that the average user * should not see. Mappings can use this as a security hint. + * @return if the endpoint is sensitive */ boolean isSensitive(); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java index 1066adf1dc3..b057f3fcb15 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +44,8 @@ public class HealthEndpoint extends AbstractEndpoint { /** * Create a new {@link HealthIndicator} instance. + * @param healthAggregator the health aggregator + * @param healthIndicators the health indicators */ public HealthEndpoint(HealthAggregator healthAggregator, Map healthIndicators) { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java index 1b5269a7cfb..31b7a98cad2 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +64,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered { /** * Add basic system metrics. + * @param result the result */ protected void addBasicMetrics(Collection> result) { result.add(new Metric("mem", Runtime.getRuntime().totalMemory() / 1024)); @@ -81,6 +82,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered { /** * Add JVM heap metrics. + * @param result the result */ protected void addHeapMetrics(Collection> result) { MemoryUsage memoryUsage = ManagementFactory.getMemoryMXBean() @@ -93,6 +95,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered { /** * Add thread metrics. + * @param result the result */ protected void addThreadMetrics(Collection> result) { ThreadMXBean threadMxBean = ManagementFactory.getThreadMXBean(); @@ -105,6 +108,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered { /** * Add class loading metrics. + * @param result the result */ protected void addClassLoadingMetrics(Collection> result) { ClassLoadingMXBean classLoadingMxBean = ManagementFactory.getClassLoadingMXBean(); @@ -118,6 +122,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered { /** * Add garbage collection metrics. + * @param result the result */ protected void addGarbageCollectionMetrics(Collection> result) { List garbageCollectorMxBeans = ManagementFactory diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java index 5257d5e2dba..74cb67ed96f 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -60,7 +60,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme /** * Create a new {@link EndpointHandlerMapping} instance. All {@link Endpoint}s will be * detected from the {@link ApplicationContext}. - * @param endpoints + * @param endpoints the endpoints */ public EndpointHandlerMapping(Collection endpoints) { this.endpoints = new HashSet(endpoints); @@ -148,6 +148,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme } /** + * @param endpoint the endpoint * @return the path used in mappings */ public String getPath(String endpoint) { @@ -156,6 +157,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme /** * Sets if this mapping is disabled. + * @param disabled if the mapping is disabled */ public void setDisabled(boolean disabled) { this.disabled = disabled; @@ -163,6 +165,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme /** * Returns if this mapping is disabled. + * @return if the mapping is disabled */ public boolean isDisabled() { return this.disabled; @@ -170,6 +173,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme /** * Return the endpoints + * @return the endpoints */ public Set getEndpoints() { return new HashSet(this.endpoints); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java index 98900feb8ac..a63badc284a 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,11 +31,13 @@ public interface MvcEndpoint { /** * Return the MVC path of the endpoint. + * @return the endpoint path */ String getPath(); /** * Return if the endpoint exposes sensitive information. + * @return if the endpoint is sensitive */ boolean isSensitive(); @@ -43,6 +45,7 @@ public interface MvcEndpoint { * Return the type of {@link Endpoint} exposed, or {@code null} if this * {@link MvcEndpoint} exposes information that cannot be represented as a traditional * {@link Endpoint}. + * @return the endpoint type */ @SuppressWarnings("rawtypes") Class getEndpointType(); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthAggregator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthAggregator.java index 30348abbca0..82e799bbc9d 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthAggregator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthAggregator.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ public abstract class AbstractHealthAggregator implements HealthAggregator { /** * Return the single 'aggregate' status that should be used from the specified * candidates. - * @param candidates + * @param candidates the candidates * @return a single status */ protected abstract Status aggregateStatus(List candidates); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java index 4de09d72283..648ccc85457 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +37,7 @@ public class CompositeHealthIndicator implements HealthIndicator { /** * Create a new {@link CompositeHealthIndicator}. + * @param healthAggregator the health aggregator */ public CompositeHealthIndicator(HealthAggregator healthAggregator) { this(healthAggregator, new LinkedHashMap()); @@ -44,6 +45,7 @@ public class CompositeHealthIndicator implements HealthIndicator { /** * Create a new {@link CompositeHealthIndicator} from the specified indicators. + * @param healthAggregator the health aggregator * @param indicators a map of {@link HealthIndicator}s with the key being used as an * indicator name. */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java index c8506ab1c45..1cfc68f15c2 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -153,6 +153,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement /** * Set the {@link DataSource} to use. + * @param dataSource the data source */ public void setDataSource(DataSource dataSource) { this.dataSource = dataSource; @@ -162,6 +163,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement /** * Set a specific validation query to use to validate a connection. If none is set, a * default validation query is used. + * @param query the query */ public void setQuery(String query) { this.query = query; @@ -169,6 +171,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement /** * Return the validation query or {@code null}. + * @return the query */ public String getQuery() { return this.query; diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java index 37c129e359b..293c44b6177 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java @@ -1,5 +1,5 @@ /* - * Copyright 2014 the original author or authors. + * Copyright 2014-2015 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 @@ public class DiskSpaceHealthIndicator extends AbstractHealthIndicator { /** * Create a new {@code DiskSpaceHealthIndicator} + * @param properties the disk space properties */ @Autowired public DiskSpaceHealthIndicator(DiskSpaceHealthIndicatorProperties properties) { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java index a6f5f490fff..ab9031d438c 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -150,6 +150,7 @@ public final class Health { /** * Create a new {@link Builder} instance with a specific status code. + * @param statusCode the status code * @return a new {@link Builder} instance */ public static Builder status(String statusCode) { @@ -158,6 +159,7 @@ public final class Health { /** * Create a new {@link Builder} instance with a specific {@link Status}. + * @param status the status * @return a new {@link Builder} instance */ public static Builder status(Status status) { @@ -270,6 +272,7 @@ public final class Health { /** * Set status to given statusCode. + * @param statusCode the status code * @return this {@link Builder} instance */ public Builder status(String statusCode) { @@ -278,7 +281,7 @@ public final class Health { /** * Set status to given {@link Status} instance - * @param status + * @param status the status * @return this {@link Builder} instance */ public Builder status(Status status) { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java index 2446f41d7ed..24e4c1922e8 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +38,8 @@ public interface HealthAggregator { /** * Aggregate several given {@link Health} instances into one. + * @param healths the health instances to aggregate + * @return the aggregated health */ Health aggregate(Map healths); } diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/Metric.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/Metric.java index b6bef121570..c16b62706d9 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/Metric.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/Metric.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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,7 @@ import org.springframework.util.ObjectUtils; * named numeric value with a timestamp). For example a metric might record the number of * active connections to a server, or the temperature of a meeting room. * + * @param the value type * @author Dave Syer */ public class Metric { @@ -60,6 +61,7 @@ public class Metric { /** * Returns the name of the metric. + * @return the name */ public String getName() { return this.name; @@ -67,6 +69,7 @@ public class Metric { /** * Returns the value of the metric. + * @return the value */ public T getValue() { return this.value; @@ -94,6 +97,7 @@ public class Metric { /** * Create a new {@link Metric} with a different value. + * @param the metric value type * @param value the value of the new metric * @return a new {@link Metric} instance */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/util/SimpleInMemoryRepository.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/util/SimpleInMemoryRepository.java index d8763b67020..e256884f4e3 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/util/SimpleInMemoryRepository.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/util/SimpleInMemoryRepository.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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.ConcurrentReferenceHashMap; /** * Repository utility that stores stuff in memory with period-separated String keys. * + * @param the type to store * @author Dave Syer */ public class SimpleInMemoryRepository { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/Delta.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/Delta.java index 9d22491a15d..679fb2fe233 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/Delta.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/Delta.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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.boot.actuate.metrics.Metric; /** * A value object representing an increment in a metric value (usually a counter). * + * @param the value type * @author Dave Syer */ public class Delta extends Metric { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/MetricWriter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/MetricWriter.java index c6dc68a9257..4bf94ebda9d 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/MetricWriter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/MetricWriter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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 @@ public interface MetricWriter { /** * Set the value of a metric. - * @param value + * @param value the value */ void set(Metric value); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java index c3019934d8e..b7fbbae5028 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ public interface PrefixMetricWriter { /** * Increment the value of a metric (or decrement if the delta is negative). The name * of the metric to increment is group + "." + delta.name. + * @param group the name of the group * @param delta the amount to increment by */ void increment(String group, Delta delta); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/ApplicationPidFileWriter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/ApplicationPidFileWriter.java index e2c4ffc941f..65ce2f70d3c 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/ApplicationPidFileWriter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/ApplicationPidFileWriter.java @@ -1,5 +1,5 @@ /* - * Copyright 2010-2014 the original author or authors. + * Copyright 2010-2015 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. @@ -92,6 +92,7 @@ public class ApplicationPidFileWriter implements * Defaults to {@link ApplicationPreparedEvent}. NOTE: If you use the * {@link ApplicationPreparedEvent} to trigger the write, you will not be able to * specify the PID filename in the Spring {@link Environment}. + * @param triggerEventType the event trigger type */ public void setTriggerEventType( Class triggerEventType) { diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/TraceRepository.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/TraceRepository.java index 8479f76304f..49bca041d13 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/TraceRepository.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/TraceRepository.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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 @@ public interface TraceRepository { /** * Find all {@link Trace} objects contained in the repository. + * @return the results */ List findAll(); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java index b5b232670d1..410364a27e4 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,8 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order private ErrorAttributes errorAttributes; /** - * @param traceRepository + * Create a new {@link WebRequestTraceFilter} instance. + * @param traceRepository the trace repository */ public WebRequestTraceFilter(TraceRepository traceRepository) { this.traceRepository = traceRepository; @@ -66,6 +67,7 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order /** * Debugging feature. If enabled, and trace logging is enabled then web request * headers will be logged. + * @param dumpRequests if requests should be logged */ public void setDumpRequests(boolean dumpRequests) { this.dumpRequests = dumpRequests; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java index faaa64c062f..7a65541d255 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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 @@ public @interface AutoConfigureAfter { /** * The auto-configure classes that should have already been applied. + * @return the classes */ Class[] value(); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java index 089f63faf95..f1d166ceb99 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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 @@ public @interface AutoConfigureBefore { /** * The auto-configure classes that should have not yet been applied. + * @return the classes */ Class[] value(); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java index f42375d8942..78186cf9f6d 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -74,6 +74,7 @@ public @interface EnableAutoConfiguration { /** * Exclude specific auto-configuration classes such that they will never be applied. + * @return the classes to exclude */ Class[] exclude() default {}; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java index 6bccb2c764f..34f31b435e5 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -48,6 +48,7 @@ public @interface SpringBootApplication { /** * Exclude specific auto-configuration classes such that they will never be applied. + * @return the classes to exclude */ Class[] exclude() default {}; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AnyNestedCondition.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AnyNestedCondition.java index 9a636ed180c..963ed222fb8 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AnyNestedCondition.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AnyNestedCondition.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -46,11 +46,11 @@ import org.springframework.util.StringUtils; *
  * static class OnJndiOrProperty extends AnyNestedCondition {
  *
- *    @ConditionalOnJndi()
+ *    @ConditionalOnJndi()
  *    static class OnJndi {
  *    }
 
- *    @ConditionalOnProperty("something")
+ *    @ConditionalOnProperty("something")
  *    static class OnProperty {
  *    }
  *
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/BeanTypeRegistry.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/BeanTypeRegistry.java
index 8edcea801fa..39b7348eca4 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/BeanTypeRegistry.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/BeanTypeRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -291,6 +291,8 @@ abstract class BeanTypeRegistry {
 
 		/**
 		 * Returns the {@link OptimizedBeanTypeRegistry} for the given bean factory.
+		 * @param factory the source {@link BeanFactory}
+		 * @return the {@link OptimizedBeanTypeRegistry}
 		 */
 		public static OptimizedBeanTypeRegistry getFromFactory(
 				DefaultListableBeanFactory factory) {
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.java
index 4a30f452779..14947198312 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public class ConditionEvaluationReport {
 
 	/**
 	 * Returns condition outcomes from this report, grouped by the source.
+	 * @return the condition outcomes
 	 */
 	public Map getConditionAndOutcomesBySource() {
 		return Collections.unmodifiableMap(this.outcomes);
@@ -127,6 +128,7 @@ public class ConditionEvaluationReport {
 
 		/**
 		 * Return {@code true} if all outcomes match.
+		 * @return {@code true} if a full match
 		 */
 		public boolean isFullMatch() {
 			for (ConditionAndOutcome conditionAndOutcomes : this) {
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionOutcome.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionOutcome.java
index 846895b6dcb..a004c860674 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionOutcome.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionOutcome.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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 @@ public class ConditionOutcome {
 
 	/**
 	 * Create a new {@link ConditionOutcome} instance for a 'match'.
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome match() {
 		return match(null);
@@ -44,6 +45,7 @@ public class ConditionOutcome {
 	/**
 	 * Create a new {@link ConditionOutcome} instance for 'match'.
 	 * @param message the message
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome match(String message) {
 		return new ConditionOutcome(true, message);
@@ -52,6 +54,7 @@ public class ConditionOutcome {
 	/**
 	 * Create a new {@link ConditionOutcome} instance for 'no match'.
 	 * @param message the message
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome noMatch(String message) {
 		return new ConditionOutcome(false, message);
@@ -59,6 +62,7 @@ public class ConditionOutcome {
 
 	/**
 	 * Return {@code true} if the outcome was a match.
+	 * @return {@code true} if the outcome matches
 	 */
 	public boolean isMatch() {
 		return this.match;
@@ -66,6 +70,7 @@ public class ConditionOutcome {
 
 	/**
 	 * Return an outcome message or {@code null}.
+	 * @return the message or {@code null}
 	 */
 	public String getMessage() {
 		return this.message;
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java
index 4640d6033fb..82493ad9b51 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -70,6 +70,7 @@ public @interface ConditionalOnBean {
 	/**
 	 * Strategy to decide if the application context hierarchy (parent contexts) should be
 	 * considered.
+	 * @return the search strategy
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.java
index d5beba72edd..9e82bfc59f3 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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,6 +37,7 @@ public @interface ConditionalOnExpression {
 	/**
 	 * The SpEL expression to evaluate. Expression should return {@code true} if the
 	 * condition passes or {@code false} if it fails.
+	 * @return the SpEL expression
 	 */
 	String value() default "true";
 
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJava.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJava.java
index e4afa7a8665..e5918dea330 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJava.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJava.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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,12 +43,14 @@ public @interface ConditionalOnJava {
 	 * Configures whether the value configured in {@link #value()} shall be considered the
 	 * upper exclusive or lower inclusive boundary. Defaults to
 	 * {@link Range#EQUAL_OR_NEWER}.
+	 * @return the range
 	 */
 	Range range() default Range.EQUAL_OR_NEWER;
 
 	/**
 	 * The {@link JavaVersion} to check for. Use {@link #range()} to specify whether the
 	 * configured value is an upper-exclusive or lower-inclusive boundary.
+	 * @return the java version
 	 */
 	JavaVersion value();
 
@@ -128,6 +130,7 @@ public @interface ConditionalOnJava {
 
 		/**
 		 * Returns the {@link JavaVersion} of the current runtime.
+		 * @return the {@link JavaVersion}
 		 */
 		public static JavaVersion getJavaVersion() {
 			int version = JdkVersion.getMajorJavaVersion();
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJndi.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJndi.java
index abad20dccf5..d0689b12836 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJndi.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJndi.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -42,6 +42,7 @@ public @interface ConditionalOnJndi {
 	/**
 	 * JNDI Locations, one of which must exist. If no locations are specific the condition
 	 * matches solely based on the presence of an {@link InitialContext}.
+	 * @return the JNDI locations
 	 */
 	String[] value() default {};
 
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
index 30df19a48ff..55e84e44999 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public @interface ConditionalOnMissingBean {
 	/**
 	 * Strategy to decide if the application context hierarchy (parent contexts) should be
 	 * considered.
+	 * @return the search strategy
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java
index b8ef838e23a..2e398005d93 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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,7 @@ import org.springframework.core.env.Environment;
  * should have. The table below shows when a condition matches according to the property
  * value and the {@link #havingValue()} attribute:
  *
- * 

- * + *
* * * @@ -84,12 +83,14 @@ public @interface ConditionalOnProperty { /** * Alias for {@link #name()}. + * @return the names */ String[] value() default {}; /** * A prefix that should be applied to each property. The prefix automatically ends * with a dot if not specified. + * @return the prefix */ String prefix() default ""; @@ -101,23 +102,27 @@ public @interface ConditionalOnProperty { *

* Use the dashed notation to specify each property, that is all lower case with a "-" * to separate words (e.g. {@code my-long-property}). + * @return the names */ String[] name() default {}; /** * The string representation of the expected value for the properties. If not - * specified, the property must not be equals to {@code false} + * specified, the property must not be equals to {@code false}. + * @return the expected value */ String havingValue() default ""; /** * Specify if the condition should match if the property is not set. Defaults to - * {@code false} + * {@code false}. + * @return if should match if the property is missing */ boolean matchIfMissing() default false; /** * If relaxed names should be checked. Defaults to {@code true}. + * @return if relaxed names are used */ boolean relaxedNames() default true; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/SpringBootCondition.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/SpringBootCondition.java index eea17c97f5a..aa1dcb3e877 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/SpringBootCondition.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/SpringBootCondition.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -112,6 +112,9 @@ public abstract class SpringBootCondition implements Condition { /** * Determine the outcome of the match along with suitable log output. + * @param context the condition context + * @param metadata the annotation metadata + * @return the condition outcome */ public abstract ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/AbstractRepositoryConfigurationSourceSupport.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/AbstractRepositoryConfigurationSourceSupport.java index 0869904990d..fcf70cb6068 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/AbstractRepositoryConfigurationSourceSupport.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/AbstractRepositoryConfigurationSourceSupport.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -79,16 +79,19 @@ public abstract class AbstractRepositoryConfigurationSourceSupport implements /** * The Spring Data annotation used to enable the particular repository support. + * @return the annotation class */ protected abstract Class getAnnotation(); /** * The configuration class that will be used by Spring Boot as a template. + * @return the configuration class */ protected abstract Class getConfiguration(); /** * The {@link RepositoryConfigurationExtension} for the particular repository support. + * @return the repository configuration extension */ protected abstract RepositoryConfigurationExtension getRepositoryConfigurationExtension(); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java index f210942932a..2a5de7a3cbb 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -71,6 +71,7 @@ public class DataSourceAutoConfiguration { /** * Determines if the {@code dataSource} being used by Spring was created from * {@link EmbeddedDataSourceConfiguration}. + * @param beanFactory the bean factory * @return true if the data source was auto-configured. */ public static boolean containsAutoConfiguredDataSource( diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/EmbeddedDatabaseConnection.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/EmbeddedDatabaseConnection.java index b1cbe9393bd..2803192b70a 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/EmbeddedDatabaseConnection.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/EmbeddedDatabaseConnection.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -73,6 +73,7 @@ public enum EmbeddedDatabaseConnection { /** * Returns the driver class name. + * @return the driver class name */ public String getDriverClassName() { return this.driverClass; @@ -80,6 +81,7 @@ public enum EmbeddedDatabaseConnection { /** * Returns the {@link EmbeddedDatabaseType} for the connection. + * @return the database type */ public EmbeddedDatabaseType getType() { return this.type; @@ -87,6 +89,7 @@ public enum EmbeddedDatabaseConnection { /** * Returns the URL for the connection. + * @return the connection URL */ public String getUrl() { return this.url; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java index c0f271d3afe..a98a8664d87 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -21,6 +21,7 @@ import javax.sql.DataSource; /** * A base {@link DataSourcePoolMetadata} implementation. * + * @param The datasource type * @author Stephane Nicoll * @since 1.2.0 */ @@ -31,6 +32,7 @@ public abstract class AbstractDataSourcePoolMetadata imple /** * Create an instance with the data source to use. + * @param dataSource the data source */ protected AbstractDataSourcePoolMetadata(T dataSource) { this.dataSource = dataSource; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadata.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadata.java index d75cd041f48..30f6d6dbae2 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadata.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadata.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,12 +37,14 @@ public interface DataSourcePoolMetadata { * * This may also return {@code null} if the data source does not provide the necessary * information to compute the poll usage. + * @return the usage value or {@code null} */ Float getUsage(); /** * Return the current number of active connections that have been allocated from the * data source or {@code null} if that information is not available. + * @return the number of active connections or {@code null} */ Integer getActive(); @@ -50,18 +52,21 @@ public interface DataSourcePoolMetadata { * Return the maximum number of active connections that can be allocated at the same * time or {@code -1} if there is no limit. Can also return {@code null} if that * information is not available. + * @return the maximum number of active connections or {@code null} */ Integer getMax(); /** * Return the minimum number of idle connections in the pool or {@code null} if that * information is not available. + * @return the minimum number of active connections or {@code null} */ Integer getMin(); /** * Return the query to use to validate that a connection is valid or {@code null} if * that information is not available. + * @return the validation query or {@code null} */ String getValidationQuery(); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvider.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvider.java index 95faec8c23a..4ec0ee5545f 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvider.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvider.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,8 @@ public interface DataSourcePoolMetadataProvider { /** * Return the {@link DataSourcePoolMetadata} instance able to manage the specified * {@link DataSource} or {@code null} if the given data source could not be handled. + * @param dataSource the data source + * @return the data source pool metadata */ DataSourcePoolMetadata getDataSourcePoolMetadata(DataSource dataSource); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProviders.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProviders.java index 875ff14dd7a..e218177d292 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProviders.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProviders.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ public class DataSourcePoolMetadataProviders implements DataSourcePoolMetadataPr /** * Create a {@link DataSourcePoolMetadataProviders} instance with an initial * collection of delegates to use. + * @param providers the data source pool metdata providers */ public DataSourcePoolMetadataProviders( Collection providers) { diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/TomcatDataSourcePoolMetadata.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/TomcatDataSourcePoolMetadata.java index 9112f865ae4..5dcc6b4ab61 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/TomcatDataSourcePoolMetadata.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/TomcatDataSourcePoolMetadata.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ import org.apache.tomcat.jdbc.pool.ConnectionPool; import org.apache.tomcat.jdbc.pool.DataSource; /** - * {@link DataSourcePoolMetadata} for a Tomcat {@link DataSource}. + * {@link DataSourcePoolMetadata} for a Tomcat DataSource. * * @author Stephane Nicoll */ diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/hornetq/HornetQProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/hornetq/HornetQProperties.java index 87135974bd2..f929cb427a3 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/hornetq/HornetQProperties.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/hornetq/HornetQProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -187,6 +187,7 @@ public class HornetQProperties { /** * Creates the minimal transport parameters for an embedded transport * configuration. + * @return the transport parameters * @see TransportConstants#SERVER_ID_PROP_NAME */ public Map generateTransportParameters() { diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java index af710e687d1..ddc91673b51 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -71,6 +71,7 @@ public class EntityManagerFactoryBuilder { /** * An optional callback for new entity manager factory beans. + * @param callback the entity manager factory bean callback */ public void setCallback(EntityManagerFactoryBeanCallback callback) { this.callback = callback; diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java index eb195dde6bb..8e50404fcc6 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java @@ -147,6 +147,7 @@ public abstract class JpaBaseConfiguration implements BeanFactoryAware { /** * Returns if a JTA {@link PlatformTransactionManager} is being used. + * @return if a JTA transaction manager is being used */ protected final boolean isJta() { return (this.jtaTransactionManager != null); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java index 38bd6d970d5..defb3cb4afb 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -103,6 +103,7 @@ public abstract class AbstractViewResolverProperties { /** * @deprecated since 1.2.0 in favor of {@link #getCharset()} + * @return the charset */ @Deprecated public String getCharSet() { @@ -111,6 +112,7 @@ public abstract class AbstractViewResolverProperties { /** * @deprecated since 1.2.0 in favor of {@link #setCharset(String)} + * @param charSet the charset */ @Deprecated public void setCharSet(String charSet) { diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/TemplateAvailabilityProvider.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/TemplateAvailabilityProvider.java index f6de4d1c7ec..07e800da400 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/TemplateAvailabilityProvider.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/TemplateAvailabilityProvider.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +34,7 @@ public interface TemplateAvailabilityProvider { * @param environment the environment * @param classLoader the class loader * @param resourceLoader the resource loader + * @return if the template is available */ boolean isTemplateAvailable(String view, Environment environment, ClassLoader classLoader, ResourceLoader resourceLoader); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorController.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorController.java index 068c1d24182..55ecee7ea01 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorController.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorController.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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 @@ public interface ErrorController { /** * Returns the path of the error page. + * @return the error path */ public String getErrorPath(); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java index ae74f5533d7..f1eb822806b 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2015 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.web.servlet.DispatcherServlet; * {@link javax.servlet.MultipartConfigElement multipartConfigElement} if none is * otherwise defined. The {@link EmbeddedWebApplicationContext} will associate the * {@link MultipartConfigElement} bean to any {@link Servlet} beans. - *

+ *

* The {@link javax.servlet.MultipartConfigElement} is a Servlet API that's used to * configure how the container handles file uploads. By default * diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketContainerCustomizer.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketContainerCustomizer.java index 83a70d7a67d..d26e5fc661c 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketContainerCustomizer.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketContainerCustomizer.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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.core.ResolvableType; * {@link EmbeddedServletContainerCustomizer} to configure websockets for a given * {@link EmbeddedServletContainerFactory}. * + * @param the embded servlet container factory * @author Dave Syer * @author Phillip Webb * @author Andy Wilkinson diff --git a/spring-boot-docs/pom.xml b/spring-boot-docs/pom.xml index eadd353e1a2..12deec86bf4 100644 --- a/spring-boot-docs/pom.xml +++ b/spring-boot-docs/pom.xml @@ -39,6 +39,287 @@ org.springframework.boot spring-boot-loader-tools + + + ch.qos.logback + logback-classic + true + + + com.atomikos + transactions-jms + true + + + com.atomikos + transactions-jta + true + + + com.atomikos + transactions-jdbc + true + + + com.fasterxml.jackson.core + jackson-databind + true + + + com.google.code.gson + gson + true + + + com.googlecode.json-simple + json-simple + true + + + com.samskivert + jmustache + true + + + io.dropwizard.metrics + metrics-core + true + + + io.undertow + undertow-servlet + true + + + javax.jms + jms-api + true + + + javax.servlet + javax.servlet-api + true + + + log4j + log4j + true + + + org.apache.logging.log4j + log4j-api + true + + + org.apache.logging.log4j + log4j-core + true + + + org.apache.httpcomponents + httpclient + true + + + org.apache.tomcat.embed + tomcat-embed-core + true + + + org.apache.tomcat.embed + tomcat-embed-jasper + true + + + org.apache.tomcat.embed + tomcat-embed-logging-juli + true + + + org.codehaus.btm + btm + true + + + org.codehaus.groovy + groovy + true + + + org.codehaus.groovy + groovy-xml + true + + + org.crashub + crash.shell + true + + + org.eclipse.jetty + jetty-util + true + + + org.eclipse.jetty + jetty-servlets + true + + + org.eclipse.jetty + jetty-webapp + true + + + org.flywaydb + flyway-core + true + + + org.hibernate + hibernate-entitymanager + true + + + org.hibernate + hibernate-validator + true + + + org.hornetq + hornetq-jms-server + true + + + org.jolokia + jolokia-core + true + + + org.liquibase + liquibase-core + true + + + org.slf4j + slf4j-api + true + + + org.slf4j + jul-to-slf4j + true + + + org.springframework + spring-messaging + true + + + org.springframework + spring-orm + true + + + org.springframework + spring-test + true + + + org.springframework + spring-web + true + + + org.springframework + spring-webmvc + true + + + org.springframework.amqp + spring-rabbit + true + + + org.springframework.batch + spring-batch-core + true + + + org.springframework.cloud + spring-cloud-core + true + + + org.springframework.cloud + spring-cloud-spring-service-connector + true + + + org.springframework.security + spring-security-config + true + + + org.springframework.data + spring-data-elasticsearch + true + + + org.springframework.data + spring-data-jpa + true + + + org.springframework.data + spring-data-mongodb + true + + + org.springframework.data + spring-data-rest-core + true + + + org.springframework.data + spring-data-rest-webmvc + true + + + org.springframework.data + spring-data-solr + true + + + org.springframework.hateoas + spring-hateoas + true + + + org.springframework.mobile + spring-mobile-device + true + + + org.springframework.security + spring-security-web + true + + + org.springframework.social + spring-social-config + true + + + org.thymeleaf + thymeleaf-spring4 + true + + + org.yaml + snakeyaml + true + @@ -63,8 +344,13 @@ true ${basedir}/src/main/javadoc/spring-javadoc.css - http://docs.spring.io/spring-framework/docs/4.0.x/javadoc-api/ http://docs.oracle.com/javase/7/docs/api/ + http://docs.oracle.com/javaee/7/api/ + http://docs.spring.io/spring-framework/docs/${spring.version}/javadoc-api/ + http://docs.spring.io/autorepo/docs/spring-security/${spring-security.version}/apidocs/ + http://tomcat.apache.org/tomcat-8.0-doc/api/ + http://download.eclipse.org/jetty/stable-9/apidocs/ + http://www.thymeleaf.org/apidocs/thymeleaf/${thymeleaf.version}/ diff --git a/spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/PluginFeatures.java b/spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/PluginFeatures.java index acc51a57c95..d115e7f0783 100644 --- a/spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/PluginFeatures.java +++ b/spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/PluginFeatures.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,11 @@ package org.springframework.boot.gradle; -import org.gradle.api.Plugin; import org.gradle.api.Project; /** - * A specific set of {@link Plugin} features applied via the {@link SpringBootPlugin}. + * A specific set of {@code org.gradle.api.Plugin} features applied via the + * {@code SpringBootPlugin}. * * @author Phillip Webb */ diff --git a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/DependencyFilter.java b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/DependencyFilter.java index e9ca8a1f993..152523386cf 100644 --- a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/DependencyFilter.java +++ b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/DependencyFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2014 the original author or authors. + * Copyright 2014-2015 the original author or authors. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -38,6 +38,7 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter { /** * Create a new instance with the list of {@link FilterableDependency} instance(s) to * use. + * @param dependencies the source dependencies */ public DependencyFilter(List dependencies) { this.filters = dependencies; @@ -61,6 +62,9 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter { * Check if the specified {@link org.apache.maven.artifact.Artifact} matches the * specified {@link org.springframework.boot.maven.FilterableDependency}. Returns * {@code true} if it should be excluded + * @param artifact the Maven {@link Artifact} + * @param dependency the {@link FilterableDependency} + * @return {@code true} if the artifact matches the dependency */ protected final boolean equals(Artifact artifact, FilterableDependency dependency) { if (!dependency.getGroupId().equals(artifact.getGroupId())) { diff --git a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ExcludeFilter.java b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ExcludeFilter.java index 9104159acf5..3c86b46b8a2 100644 --- a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ExcludeFilter.java +++ b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ExcludeFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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. @@ -21,8 +21,7 @@ import java.util.List; import org.apache.maven.artifact.Artifact; /** - * An {@ArtifactsFilter} that filters out any artifact matching an - * {@link Exclude}. + * An {DependencyFilter} that filters out any artifact matching an {@link Exclude}. * * @author Stephane Nicoll * @author David Turanski diff --git a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/MatchingGroupIdFilter.java b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/MatchingGroupIdFilter.java index 7316acab9f8..7e125ea5e89 100644 --- a/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/MatchingGroupIdFilter.java +++ b/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/MatchingGroupIdFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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,6 +34,7 @@ public class MatchingGroupIdFilter extends AbstractArtifactFeatureFilter { /** * Create a new instance with the CSV groupId values that should be excluded. + * @param exclude the group values to exclude */ public MatchingGroupIdFilter(String exclude) { super("", exclude); diff --git a/spring-boot/src/main/java/org/springframework/boot/json/JsonJsonParser.java b/spring-boot/src/main/java/org/springframework/boot/json/JsonJsonParser.java index 69a9e59cc05..9a41190b29f 100644 --- a/spring-boot/src/main/java/org/springframework/boot/json/JsonJsonParser.java +++ b/spring-boot/src/main/java/org/springframework/boot/json/JsonJsonParser.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2015 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.json.JSONArray; import org.json.JSONObject; /** - * Thin wrapper to adapt {@link org.json.JSONObject} to a {@link JsonParser}. + * Thin wrapper to adapt {@code org.json.JSONObject} to a {@link JsonParser}. * * @author Dave Syer * @since 1.2.0

Property Value{@code havingValue=""}