From ccdbfd274f679776ca636abff43700ecabe1dbc2 Mon Sep 17 00:00:00 2001
From: Phillip Webb
* 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.
- *
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 2446f41d7e..24e4c1922e 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(Mapgroup + "." + 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 e2c4ffc941..65ce2f70d3 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 extends SpringApplicationEvent> 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 8479f76304..49bca041d1 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* 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 8edcea801f..39b7348eca 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 4a30f45277..1494719831 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 MapgetConditionAndOutcomesBySource() { 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 846895b6dc..a004c86067 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 4640d6033f..82493ad9b5 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 d5beba72ed..9e82bfc59f 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 e4afa7a866..e5918dea33 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 abad20dccf..d0689b1283 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 30df19a48f..55e84e4499 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 b8ef838e23..2e398005d9 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: * - * - *
+ *
*
* Property Value *{@code havingValue=""} @@ -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 eea17c97f5..aa1dcb3e87 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 0869904990..fcf70cb606 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 extends Annotation> 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 f210942932..2a5de7a3cb 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 b1cbe9393b..2803192b70 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 c0f271d3af..a98a8664d8 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 d75cd041f4..30f6d6dbae 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 95faec8c23..4ec0ee5545 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 875ff14dd7..e218177d29 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 extends DataSourcePoolMetadataProvider> 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 9112f865ae..5dcc6b4ab6 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 87135974bd..f929cb427a 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 af710e687d..ddc91673b5 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 eb195dde6b..8e50404fcc 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 38bd6d970d..defb3cb4af 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 f6de4d1c7e..07e800da40 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 068c1d2418..55ecee7ea0 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 ae74f5533d..f1eb822806 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 83a70d7a67..d26e5fc661 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 eadd353e1a..12deec86bf 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 acc51a57c9..d115e7f078 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 e9ca8a1f99..152523386c 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 extends FilterableDependency> 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 9104159acf..3c86b46b8a 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 7316acab9f..7e125ea5e8 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 69a9e59cc0..9a41190b29 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