Polish Javadoc

This commit is contained in:
Phillip Webb
2015-09-06 00:28:00 -07:00
parent e07df7e4c6
commit e674d751de
252 changed files with 680 additions and 348 deletions

View File

@@ -33,7 +33,7 @@ import org.springframework.util.StringUtils;
/**
* Abstract base class for a {@link BeanFactoryPostProcessor} that can be used to
* dynamically declare that all beans of a specific type should depend on one or more
* specific beans
* specific beans.
*
* @author Marcel Overdijk
* @author Dave Syer

View File

@@ -62,7 +62,7 @@ public abstract class AutoConfigurationPackages {
}
/**
* Return the auto-configuration base packages for the given bean factory
* Return the auto-configuration base packages for the given bean factory.
* @param beanFactory the source bean factory
* @return a list of auto-configuration packages
* @throws IllegalStateException if auto-configuration is not enabled

View File

@@ -30,6 +30,7 @@ public class JobExecutionEvent extends ApplicationEvent {
private final JobExecution execution;
/**
* Create a new {@link JobExecutionEvent} instance.
* @param execution the job execution
*/
public JobExecutionEvent(JobExecution execution) {
@@ -38,6 +39,7 @@ public class JobExecutionEvent extends ApplicationEvent {
}
/**
* Return the job execution.
* @return the job execution
*/
public JobExecution getJobExecution() {

View File

@@ -42,7 +42,7 @@ public enum CacheType {
EHCACHE,
/**
* Hazelcast backed caching
* Hazelcast backed caching.
*/
HAZELCAST,

View File

@@ -38,6 +38,8 @@ import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
/**
* Abstract base class for nested conditions.
*
* @author Phillip Webb
*/
abstract class AbstractNestedCondition extends SpringBootCondition implements

View File

@@ -88,7 +88,7 @@ public final class ConditionEvaluationReport {
}
/**
* Records the name of the classes that have been excluded from condition evaluation
* Records the name of the classes that have been excluded from condition evaluation.
* @param exclusions the names of the excluded classes
*/
public void recordExclusions(Collection<String> exclusions) {
@@ -97,7 +97,7 @@ public final class ConditionEvaluationReport {
}
/**
* Records the names of the classes that are candidates for condition evaluation
* Records the names of the classes that are candidates for condition evaluation.
* @param evaluationCandidates the names of the classes whose conditions will be
* evaluated
*/

View File

@@ -27,7 +27,7 @@ import org.springframework.core.annotation.Order;
import org.springframework.core.type.AnnotatedTypeMetadata;
/**
* {@link Condition} that checks for a required version of Java
* {@link Condition} that checks for a required version of Java.
*
* @author Oliver Gierke
* @author Phillip Webb

View File

@@ -35,8 +35,8 @@ import org.springframework.util.StringUtils;
* @author Maciej Walkowiak
* @author Phillip Webb
* @author Stephane Nicoll
* @see ConditionalOnProperty
* @since 1.1.0
* @see ConditionalOnProperty
*/
class OnPropertyCondition extends SpringBootCondition {

View File

@@ -24,17 +24,17 @@ package org.springframework.boot.autoconfigure.condition;
public enum SearchStrategy {
/**
* Search only the current context
* Search only the current context.
*/
CURRENT,
/**
* Search all parents and ancestors, but not the current context
* Search all parents and ancestors, but not the current context.
*/
PARENTS,
/**
* Search the entire hierarchy
* Search the entire hierarchy.
*/
ALL

View File

@@ -25,7 +25,7 @@ import org.springframework.dao.annotation.PersistenceExceptionTranslationPostPro
/**
* {@link EnableAutoConfiguration Auto-configuration} for Spring's persistence exception
* translation
* translation.
*
* @author Andy Wilkinson
* @since 1.2.0

View File

@@ -23,7 +23,7 @@ import org.springframework.boot.autoconfigure.template.AbstractTemplateViewResol
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* {@link ConfigurationProperties} for configuring FreeMarker
* {@link ConfigurationProperties} for configuring FreeMarker.
*
* @author Dave Syer
* @author Andy Wilkinson

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for
* FreeMarker view templates
* FreeMarker view templates.
*
* @author Andy Wilkinson
* @since 1.1.0

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for Groovy
* view templates
* view templates.
*
* @author Dave Syer
* @since 1.1.0

View File

@@ -37,7 +37,7 @@ import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
/**
* {@link EnableAutoConfiguration Auto-configuration} for H2's web console
* {@link EnableAutoConfiguration Auto-configuration} for H2's web console.
*
* @author Andy Wilkinson
* @since 1.3.0

View File

@@ -22,7 +22,7 @@ import javax.validation.constraints.Pattern;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Configuration properties for H2's console
* Configuration properties for H2's console.
*
* @author Andy Wilkinson
* @since 1.3.0

View File

@@ -31,7 +31,7 @@ import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.SerializationFeature;
/**
* Configuration properties to configure Jackson
* Configuration properties to configure Jackson.
*
* @author Andy Wilkinson
* @author Marcel Overdijk

View File

@@ -188,6 +188,8 @@ public class DataSourceAutoConfiguration {
/**
* Returns the class loader for the {@link DataSource} class. Used to ensure that
* the driver class can actually be loaded by the data source.
* @param context the condition context
* @return the class loader
*/
private ClassLoader getDataSourceClassLoader(ConditionContext context) {
Class<?> dataSourceClass = new DataSourceBuilder(context.getClassLoader())
@@ -222,7 +224,7 @@ public class DataSourceAutoConfiguration {
/**
* {@link Condition} to detect when a {@link DataSource} is available (either because
* the user provided one or because one will be auto-configured)
* the user provided one or because one will be auto-configured).
*/
@Order(Ordered.LOWEST_PRECEDENCE - 10)
static class DataSourceAvailableCondition extends SpringBootCondition {

View File

@@ -69,22 +69,22 @@ enum DatabaseDriver {
GOOGLE("com.google.appengine.api.rdbms.AppEngineDriver"),
/**
* Oracle
* Oracle.
*/
ORACLE("oracle.jdbc.OracleDriver", "oracle.jdbc.xa.client.OracleXADataSource"),
/**
* Postres
* Postres.
*/
POSTGRESQL("org.postgresql.Driver", "org.postgresql.xa.PGXADataSource"),
/**
* JTDS
* JTDS.
*/
JTDS("net.sourceforge.jtds.jdbc.Driver"),
/**
* SQL Server
* SQL Server.
*/
SQLSERVER("com.microsoft.sqlserver.jdbc.SQLServerDriver",
"com.microsoft.sqlserver.jdbc.SQLServerXADataSource");
@@ -103,14 +103,16 @@ enum DatabaseDriver {
}
/**
* @return the driverClassName or {@code null}
* Return the driver class name.
* @return the class name or {@code null}
*/
public String getDriverClassName() {
return this.driverClassName;
}
/**
* @return the xaDataSourceClassName or {@code null}
* Return the XA driver source class name.
* @return the class name or {@code null}
*/
public String getXaDataSourceClassName() {
return this.xaDataSourceClassName;

View File

@@ -53,7 +53,7 @@ class DriverClassNameProvider {
}
/**
* Find a JDBC driver class name based on given JDBC URL
* Find a JDBC driver class name based on given JDBC URL.
* @param jdbcUrl JDBC URL
* @return driver class name or null if not found
*/

View File

@@ -82,7 +82,7 @@ public class JndiConnectionFactoryAutoConfiguration {
}
/**
* Condition for JNDI name or a specific property
* Condition for JNDI name or a specific property.
*/
static class JndiOrPropertyCondition extends AnyNestedCondition {

View File

@@ -19,7 +19,7 @@ package org.springframework.boot.autoconfigure.jms.activemq;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Configuration properties for ActiveMQ
* Configuration properties for ActiveMQ.
*
* @author Greg Turnquist
* @author Stephane Nicoll

View File

@@ -92,6 +92,7 @@ class ArtemisConnectionFactoryFactory {
/**
* Deduce the {@link ArtemisMode} to use if none has been set.
* @return the mode
*/
private ArtemisMode deduceMode() {
if (this.properties.getEmbedded().isEnabled()

View File

@@ -25,7 +25,7 @@ import org.apache.activemq.artemis.core.remoting.impl.invm.TransportConstants;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Configuration properties for Artemis
* Configuration properties for Artemis.
*
* @author Eddú Meléndez
* @author Stephane Nicoll

View File

@@ -92,6 +92,7 @@ class HornetQConnectionFactoryFactory {
/**
* Deduce the {@link HornetQMode} to use if none has been set.
* @return the mode
*/
private HornetQMode deduceMode() {
if (this.properties.getEmbedded().isEnabled()

View File

@@ -25,7 +25,7 @@ import org.hornetq.core.remoting.impl.invm.TransportConstants;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Configuration properties for HornetQ
* Configuration properties for HornetQ.
*
* @author Stephane Nicoll
* @since 1.1.0

View File

@@ -48,7 +48,8 @@ public class ParentAwareNamingStrategy extends MetadataNamingStrategy implements
}
/**
* @param ensureUniqueRuntimeObjectNames the ensureUniqueRuntimeObjectNames to set
* Set if unique runtime object names should be ensured.
* @param ensureUniqueRuntimeObjectNames {@code true} if unique names should ensured.
*/
public void setEnsureUniqueRuntimeObjectNames(boolean ensureUniqueRuntimeObjectNames) {
this.ensureUniqueRuntimeObjectNames = ensureUniqueRuntimeObjectNames;

View File

@@ -183,7 +183,7 @@ public class MongoProperties {
}
/**
* Creates a {@link MongoClient} using the given {@code options}
* Creates a {@link MongoClient} using the given {@code options}.
*
* @param options the options
* @return the Mongo client

View File

@@ -25,7 +25,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
import de.flapdoodle.embed.mongo.distribution.Feature;
/**
* Configuration properties for Embedded Mongo
* Configuration properties for Embedded Mongo.
*
* @author Andy Wilkinson
* @since 1.3.0
@@ -60,4 +60,4 @@ public class EmbeddedMongoProperties {
this.features = features;
}
}
}

View File

@@ -59,14 +59,16 @@ public class MustacheResourceTemplateLoader implements TemplateLoader,
}
/**
* @param charSet the charSet to set
* Set the charset.
* @param charSet the charset
*/
public void setCharset(String charSet) {
this.charSet = charSet;
}
/**
* @param resourceLoader the resourceLoader to set
* Set the resource loader.
* @param resourceLoader the resource loader
*/
@Override
public void setResourceLoader(ResourceLoader resourceLoader) {

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for
* Mustache view templates
* Mustache view templates.
*
* @author Dave Syer
* @since 1.2.2

View File

@@ -39,8 +39,8 @@ public class MustacheView extends AbstractTemplateView {
/**
* Create a new {@link MustacheView} instance.
* @see #setTemplate(Template)
* @since 1.2.5
* @see #setTemplate(Template)
*/
public MustacheView() {
}

View File

@@ -55,14 +55,16 @@ public class MustacheViewResolver extends UrlBasedViewResolver {
}
/**
* @param compiler the compiler to set
* Set the compiler.
* @param compiler the compiler
*/
public void setCompiler(Compiler compiler) {
this.compiler = compiler;
}
/**
* @param charset the charset to set
* Set the charset.
* @param charset the charset
*/
public void setCharset(String charset) {
this.charset = charset;

View File

@@ -141,7 +141,8 @@ public abstract class JpaBaseConfiguration implements BeanFactoryAware {
}
/**
* @return the jtaTransactionManager or {@code null}
* Return the JTA transaction manager.
* @return the transaction manager or {@code null}
*/
protected JtaTransactionManager getJtaTransactionManager() {
return this.jtaTransactionManager;

View File

@@ -30,7 +30,7 @@ import org.springframework.context.annotation.Configuration;
import com.sendgrid.SendGrid;
/**
* {@link EnableAutoConfiguration Auto-configuration} for SendGrid
* {@link EnableAutoConfiguration Auto-configuration} for SendGrid.
*
* @author Maciej Walkowiak
* @since 1.3.0

View File

@@ -31,7 +31,7 @@ import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;
/**
* {@link EnableAutoConfiguration Auto-configuration} for Solr
* {@link EnableAutoConfiguration Auto-configuration} for Solr.
*
* @author Christoph Strobl
* @since 1.1.0

View File

@@ -21,7 +21,7 @@ import org.springframework.core.io.ResourceLoader;
/**
* Indicates the availability of view templates for a particular templating engine such as
* FreeMarker or Thymeleaf
* FreeMarker or Thymeleaf.
*
* @author Andy Wilkinson
* @since 1.1.0

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for
* Thymeleaf view templates
* Thymeleaf view templates.
*
* @author Andy Wilkinson
* @since 1.1.0

View File

@@ -24,7 +24,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.web.servlet.view.velocity.VelocityViewResolver;
/**
* {@link ConfigurationProperties} for configuring Velocity
* {@link ConfigurationProperties} for configuring Velocity.
*
* @author Andy Wilkinson
* @since 1.1.0

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for
* Velocity view templates
* Velocity view templates.
*
* @author Andy Wilkinson
* @since 1.1.0

View File

@@ -30,7 +30,7 @@ import org.springframework.http.converter.json.MappingJackson2HttpMessageConvert
import com.google.gson.Gson;
/**
* Configuration for HTTP Message converters that use Gson
* Configuration for HTTP Message converters that use Gson.
*
* @author Andy Wilkinson
* @since 1.2.2

View File

@@ -30,7 +30,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
/**
* Configuration for HTTP message converters that use Jackson
* Configuration for HTTP message converters that use Jackson.
*
* @author Andy Wilkinson
* @since 1.2.2

View File

@@ -23,7 +23,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link TemplateAvailabilityProvider} that provides availability information for JSP
* view templates
* view templates.
*
* @author Andy Wilkinson
* @author Stephane Nicoll

View File

@@ -119,7 +119,7 @@ public class MultipartProperties {
}
/**
* Create a new {@link MultipartConfigElement} using the
* Create a new {@link MultipartConfigElement} using the properties.
* @return a new {@link MultipartConfigElement} configured using there properties
*/
public MultipartConfigElement createMultipartConfig() {

View File

@@ -206,7 +206,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer, Ord
}
/**
* Get the session timeout
* Get the session timeout.
* @return the session timeout
* @deprecated since 1.3.0 in favor of {@code session.timeout}.
*/
@@ -217,7 +217,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer, Ord
}
/**
* Set the session timeout
* Set the session timeout.
* @param sessionTimeout the session timeout
* @deprecated since 1.3.0 in favor of {@code session.timeout}.
*/
@@ -582,7 +582,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer, Ord
}
/**
* Set the format pattern for access logs
* Set the format pattern for access logs.
* @param accessLogPattern the pattern for access logs
* @deprecated since 1.3.0 in favor of {@code server.tomcat.accesslog.pattern}
*/
@@ -903,7 +903,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer, Ord
}
/**
* Set the format pattern for access logs
* Set the format pattern for access logs.
* @param accessLogPattern the pattern for access logs
* @deprecated since 1.3.0 in favor of {@code server.undertow.accesslog.pattern}
*/

View File

@@ -30,8 +30,8 @@ import static org.junit.Assert.assertEquals;
/**
* Abstract base class for {@link DataSourcePoolMetadata} tests.
*
* @author Stephane Nicoll
* @param <D> the data source pool metadata type
* @author Stephane Nicoll
*/
public abstract class AbstractDataSourcePoolMetadataTests<D extends AbstractDataSourcePoolMetadata<?>> {

View File

@@ -292,7 +292,7 @@ public class OAuth2AutoConfigurationTests {
/**
* Connect to the oauth service, get a token, and then attempt some operations using
* it.
* @param config
* @param config the client details.
*/
private void verifyAuthentication(ClientDetails config) {
verifyAuthentication(config, HttpStatus.FORBIDDEN);