Apply formatting and cleanup rules

pull/2051/head
Phillip Webb 10 years ago
parent 48db5457f1
commit 09dac5ff00

@ -33,8 +33,8 @@ import org.springframework.http.HttpStatus;
public class HealthMvcEndpointProperties { public class HealthMvcEndpointProperties {
/** /**
* Mapping of health statuses to HttpStatus codes. By default, registered * Mapping of health statuses to HttpStatus codes. By default, registered health
* health statuses map to sensible defaults (i.e. UP maps to 200). * statuses map to sensible defaults (i.e. UP maps to 200).
*/ */
private Map<String, HttpStatus> mapping = new HashMap<String, HttpStatus>(); private Map<String, HttpStatus> mapping = new HashMap<String, HttpStatus>();

@ -31,8 +31,8 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class JolokiaProperties { public class JolokiaProperties {
/** /**
* Jolokia settings. These are traditionally set using servlet parameters, refer * Jolokia settings. These are traditionally set using servlet parameters, refer to
* to the documentation of Jolokia for more details. * the documentation of Jolokia for more details.
*/ */
private Map<String, String> config = new HashMap<String, String>(); private Map<String, String> config = new HashMap<String, String>();

@ -43,8 +43,8 @@ public class ShellProperties {
/** /**
* Authentication type (can be "simple", "spring", "key" or "jaas"). Auto-detected * Authentication type (can be "simple", "spring", "key" or "jaas"). Auto-detected
* according to the environment (i.e. if Spring Security is available, "spring" is used by * according to the environment (i.e. if Spring Security is available, "spring" is
* default). * used by default).
*/ */
private String auth = "simple"; private String auth = "simple";
@ -75,8 +75,8 @@ public class ShellProperties {
private String[] disabledCommands = new String[] { "jpa*", "jdbc*", "jndi*" }; private String[] disabledCommands = new String[] { "jpa*", "jdbc*", "jndi*" };
/** /**
* Comma-separated list of plugins to disable. Certain plugins are disabled * Comma-separated list of plugins to disable. Certain plugins are disabled by default
* by default based on the environment. * based on the environment.
*/ */
private String[] disabledPlugins = new String[0]; private String[] disabledPlugins = new String[0];
@ -287,7 +287,8 @@ public class ShellProperties {
public static class Telnet extends CrshShellProperties { public static class Telnet extends CrshShellProperties {
/** /**
* Enable CRaSH telnet support. Enabled by default if the TelnetPlugin is available. * Enable CRaSH telnet support. Enabled by default if the TelnetPlugin is
* available.
*/ */
private boolean enabled = ClassUtils.isPresent("org.crsh.telnet.TelnetPlugin", private boolean enabled = ClassUtils.isPresent("org.crsh.telnet.TelnetPlugin",
ClassUtils.getDefaultClassLoader()); ClassUtils.getDefaultClassLoader());

@ -28,8 +28,8 @@ import javax.validation.constraints.Pattern;
public abstract class AbstractEndpoint<T> implements Endpoint<T> { public abstract class AbstractEndpoint<T> implements Endpoint<T> {
/** /**
* Endpoint identifier. With HTTP monitoring the identifier * Endpoint identifier. With HTTP monitoring the identifier of the endpoint is mapped
* of the endpoint is mapped to a URL (e.g. 'foo' is mapped to '/foo'). * to a URL (e.g. 'foo' is mapped to '/foo').
*/ */
@NotNull @NotNull
@Pattern(regexp = "\\w+", message = "ID must only contains letters, numbers and '_'") @Pattern(regexp = "\\w+", message = "ID must only contains letters, numbers and '_'")

@ -38,8 +38,8 @@ class Sanitizer {
} }
/** /**
* Keys that should be sanitized. Keys can be simple strings that the property * Keys that should be sanitized. Keys can be simple strings that the property ends
* ends with or regex expressions. * with or regex expressions.
* @param keysToSanitize the keys to sanitize * @param keysToSanitize the keys to sanitize
*/ */
public void setKeysToSanitize(String... keysToSanitize) { public void setKeysToSanitize(String... keysToSanitize) {

@ -121,6 +121,7 @@ public class MetricRegistryMetricReader implements MetricReader, MetricRegistryL
remove(name); remove(name);
} }
@Override
public void onCounterAdded(String name, Counter counter) { public void onCounterAdded(String name, Counter counter) {
names.put(name, name); names.put(name, name);
reverse.add(name, name); reverse.add(name, name);
@ -212,7 +213,8 @@ public class MetricRegistryMetricReader implements MetricReader, MetricRegistryL
@Override @Override
public void remove() { public void remove() {
throw new UnsupportedOperationException("You cannot remove from this iterator."); throw new UnsupportedOperationException(
"You cannot remove from this iterator.");
} }
} }

@ -60,9 +60,9 @@ public class MessageSourceAutoConfiguration {
private static final Resource[] NO_RESOURCES = {}; private static final Resource[] NO_RESOURCES = {};
/** /**
* Comma-separated list of basenames, each following the ResourceBundle convention. Essentially * Comma-separated list of basenames, each following the ResourceBundle convention.
* a fully-qualified classpath location. If it doesn't contain a package qualifier (such as * Essentially a fully-qualified classpath location. If it doesn't contain a package
* "org.mypackage"), it will be resolved from the classpath root. * qualifier (such as "org.mypackage"), it will be resolved from the classpath root.
*/ */
private String basename = "messages"; private String basename = "messages";
@ -72,8 +72,8 @@ public class MessageSourceAutoConfiguration {
private String encoding = "utf-8"; private String encoding = "utf-8";
/** /**
* Loaded resource bundle files cache expiration, in seconds. When set to * Loaded resource bundle files cache expiration, in seconds. When set to -1, bundles
* -1, bundles are cached forever. * are cached forever.
*/ */
private int cacheSeconds = -1; private int cacheSeconds = -1;

@ -127,7 +127,8 @@ public class RabbitAutoConfiguration {
protected static class MessagingTemplateConfiguration { protected static class MessagingTemplateConfiguration {
@Bean @Bean
public RabbitMessagingTemplate rabbitMessagingTemplate(RabbitTemplate rabbitTemplate) { public RabbitMessagingTemplate rabbitMessagingTemplate(
RabbitTemplate rabbitTemplate) {
return new RabbitMessagingTemplate(rabbitTemplate); return new RabbitMessagingTemplate(rabbitTemplate);
} }

@ -34,7 +34,8 @@ public class ElasticsearchProperties {
private String clusterName = "elasticsearch"; private String clusterName = "elasticsearch";
/** /**
* Comma-separated list of cluster node addresses. If not specified, starts a client node. * Comma-separated list of cluster node addresses. If not specified, starts a client
* node.
*/ */
private String clusterNodes; private String clusterNodes;

@ -56,18 +56,19 @@ public class FlywayProperties {
private String user; private String user;
/** /**
*Login password of the database to migrate. * Login password of the database to migrate.
*/ */
private String password; private String password;
/** /**
* JDBC url of the database to migrate. If not set, the primary configured * JDBC url of the database to migrate. If not set, the primary configured data source
* data source is used. * is used.
*/ */
private String url; private String url;
/** /**
* SQL statements to execute to initialize a connection immediately after obtaining it. * SQL statements to execute to initialize a connection immediately after obtaining
* it.
*/ */
private List<String> initSqls = Collections.emptyList(); private List<String> initSqls = Collections.emptyList();

@ -41,7 +41,7 @@ public class GroovyTemplateProperties extends AbstractViewResolverProperties {
private String prefix = DEFAULT_PREFIX; private String prefix = DEFAULT_PREFIX;
/** /**
*Suffix that gets appended to view names when building a URL. * Suffix that gets appended to view names when building a URL.
*/ */
private String suffix = DEFAULT_SUFFIX; private String suffix = DEFAULT_SUFFIX;

@ -38,13 +38,15 @@ import com.fasterxml.jackson.databind.SerializationFeature;
public class JacksonProperties { public class JacksonProperties {
/** /**
* Date format string (yyyy-MM-dd HH:mm:ss), or a fully-qualified date format class name. * Date format string (yyyy-MM-dd HH:mm:ss), or a fully-qualified date format class
* name.
*/ */
private String dateFormat; private String dateFormat;
/** /**
* One of the constants on Jackson's PropertyNamingStrategy (CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES). * One of the constants on Jackson's PropertyNamingStrategy
* Can also be a fully-qualified class name of a PropertyNamingStrategy subclass. * (CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES). Can also be a fully-qualified class
* name of a PropertyNamingStrategy subclass.
*/ */
private String propertyNamingStrategy; private String propertyNamingStrategy;

@ -16,15 +16,15 @@
package org.springframework.boot.autoconfigure.jdbc; package org.springframework.boot.autoconfigure.jdbc;
import com.zaxxer.hikari.HikariDataSource;
import org.apache.commons.dbcp.BasicDataSource; import org.apache.commons.dbcp.BasicDataSource;
import org.apache.tomcat.jdbc.pool.DataSource; import org.apache.tomcat.jdbc.pool.DataSource;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import com.zaxxer.hikari.HikariDataSource;
/** /**
* Expose the metadata of the supported data sources. Only used to harvest * Expose the metadata of the supported data sources. Only used to harvest the relevant
* the relevant properties metadata. * properties metadata.
* *
* @author Stephane Nicoll * @author Stephane Nicoll
* @since 1.2.0 * @since 1.2.0
@ -38,12 +38,14 @@ class DataSourceConfigMetadata {
@ConfigurationProperties(DataSourceProperties.PREFIX) @ConfigurationProperties(DataSourceProperties.PREFIX)
public HikariDataSource hikariDataSource() { public HikariDataSource hikariDataSource() {
return (HikariDataSource) DataSourceBuilder.create().type(HikariDataSource.class).build(); return (HikariDataSource) DataSourceBuilder.create().type(HikariDataSource.class)
.build();
} }
@ConfigurationProperties(DataSourceProperties.PREFIX) @ConfigurationProperties(DataSourceProperties.PREFIX)
public BasicDataSource dbcpDataSource() { public BasicDataSource dbcpDataSource() {
return (BasicDataSource)DataSourceBuilder.create().type(BasicDataSource.class).build(); return (BasicDataSource) DataSourceBuilder.create().type(BasicDataSource.class)
.build();
} }
} }

@ -62,7 +62,8 @@ public class DataSourceProperties implements BeanClassLoaderAware, InitializingB
private ClassLoader classLoader; private ClassLoader classLoader;
/** /**
* JNDI location of the datasource. Class, url, username & password are ignored when set. * JNDI location of the datasource. Class, url, username & password are ignored when
* set.
*/ */
private String jndiName; private String jndiName;

@ -39,7 +39,8 @@ public class ActiveMQProperties {
private boolean inMemory = true; private boolean inMemory = true;
/** /**
* Specify if a PooledConnectionFactory should be created instead of a regular ConnectionFactory. * Specify if a PooledConnectionFactory should be created instead of a regular
* ConnectionFactory.
*/ */
private boolean pooled; private boolean pooled;

@ -34,7 +34,8 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class HornetQProperties { public class HornetQProperties {
/** /**
* HornetQ deployment mode, auto-detected by default. Can be explicitly set to "native" or "embedded". * HornetQ deployment mode, auto-detected by default. Can be explicitly set to
* "native" or "embedded".
*/ */
private HornetQMode mode; private HornetQMode mode;

@ -73,8 +73,8 @@ public class LiquibaseProperties {
private String password; private String password;
/** /**
* JDBC url of the database to migrate. If not set, the primary configured * JDBC url of the database to migrate. If not set, the primary configured data source
* data source is used. * is used.
*/ */
private String url; private String url;

@ -94,7 +94,8 @@ public class HibernateJpaAutoConfiguration extends JpaBaseConfiguration {
} }
} }
private void configureJtaPlatform(Map<String, Object> vendorProperties) throws LinkageError { private void configureJtaPlatform(Map<String, Object> vendorProperties)
throws LinkageError {
JtaTransactionManager jtaTransactionManager = getJtaTransactionManager(); JtaTransactionManager jtaTransactionManager = getJtaTransactionManager();
if (jtaTransactionManager != null) { if (jtaTransactionManager != null) {
vendorProperties.put(JTA_PLATFORM, new SpringJtaPlatform( vendorProperties.put(JTA_PLATFORM, new SpringJtaPlatform(

@ -52,8 +52,8 @@ public class JpaProperties {
private String databasePlatform; private String databasePlatform;
/** /**
* Target database to operate on, auto-detected by default. Can be alternatively * Target database to operate on, auto-detected by default. Can be alternatively set
* set using the "databasePlatform" property. * using the "databasePlatform" property.
*/ */
private Database database = Database.DEFAULT; private Database database = Database.DEFAULT;
@ -137,9 +137,9 @@ public class JpaProperties {
private Class<?> namingStrategy; private Class<?> namingStrategy;
/** /**
* DDL mode ("none", "validate", "update", "create", "create-drop"). This is actually a shortcut * DDL mode ("none", "validate", "update", "create", "create-drop"). This is
* for the "hibernate.hbm2ddl.auto" property. Default to "create-drop" when using an embedded database, * actually a shortcut for the "hibernate.hbm2ddl.auto" property. Default to
* "none" otherwise. * "create-drop" when using an embedded database, "none" otherwise.
*/ */
private String ddlAuto; private String ddlAuto;

@ -111,21 +111,21 @@ public class RedisProperties {
private int maxIdle = 8; private int maxIdle = 8;
/** /**
* Target for the minimum number of idle connections to maintain in * Target for the minimum number of idle connections to maintain in the pool. This
* the pool. This setting only has an effect if it is positive. * setting only has an effect if it is positive.
*/ */
private int minIdle = 0; private int minIdle = 0;
/** /**
* Max number of connections that can be allocated by the pool at a given time. Use * Max number of connections that can be allocated by the pool at a given time.
* a negative value for no limit. * Use a negative value for no limit.
*/ */
private int maxActive = 8; private int maxActive = 8;
/** /**
* Maximum amount of time (in milliseconds) a connection allocation should block before * Maximum amount of time (in milliseconds) a connection allocation should block
* throwing an exception when the pool is exhausted. Use a negative value to block * before throwing an exception when the pool is exhausted. Use a negative value
* indefinitely. * to block indefinitely.
*/ */
private int maxWait = -1; private int maxWait = -1;

@ -47,22 +47,26 @@ public abstract class AbstractTemplateViewResolverProperties extends
private String requestContextAttribute; private String requestContextAttribute;
/** /**
* Set whether all request attributes should be added to the model prior to merging with the template. * Set whether all request attributes should be added to the model prior to merging
* with the template.
*/ */
private boolean exposeRequestAttributes = false; private boolean exposeRequestAttributes = false;
/** /**
* Set whether all HttpSession attributes should be added to the model prior to merging with the template. * Set whether all HttpSession attributes should be added to the model prior to
* merging with the template.
*/ */
private boolean exposeSessionAttributes = false; private boolean exposeSessionAttributes = false;
/** /**
* Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. * Set whether HttpServletRequest attributes are allowed to override (hide) controller
* generated model attributes of the same name.
*/ */
private boolean allowRequestOverride = false; private boolean allowRequestOverride = false;
/** /**
* Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". * Set whether to expose a RequestContext for use by Spring's macro library, under the
* name "springMacroRequestContext".
*/ */
private boolean exposeSpringMacroHelpers = true; private boolean exposeSpringMacroHelpers = true;

@ -56,8 +56,8 @@ public class MultipartProperties {
private String location; private String location;
/** /**
* Max file size. Values can use the suffixed "MB" or "KB" to indicate a Megabyte * Max file size. Values can use the suffixed "MB" or "KB" to indicate a Megabyte or
* or Kilobyte size. * Kilobyte size.
*/ */
private String maxFileSize = "1Mb"; private String maxFileSize = "1Mb";
@ -68,8 +68,8 @@ public class MultipartProperties {
private String maxRequestSize = "10Mb"; private String maxRequestSize = "10Mb";
/** /**
* Threshold after which files will be written to disk. Values can use the suffixed "MB" * Threshold after which files will be written to disk. Values can use the suffixed
* or "KB" to indicate a Megabyte or Kilobyte size. * "MB" or "KB" to indicate a Megabyte or Kilobyte size.
*/ */
private String fileSizeThreshold = "0"; private String fileSizeThreshold = "0";

@ -260,8 +260,8 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer {
+ "127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"; // 127/8 + "127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"; // 127/8
/** /**
* Header that holds the incoming protocol, usually named "X-Forwarded-Proto". Configured * Header that holds the incoming protocol, usually named "X-Forwarded-Proto".
* as a RemoteIpValve only if remoteIpHeader is also set. * Configured as a RemoteIpValve only if remoteIpHeader is also set.
*/ */
private String protocolHeader; private String protocolHeader;
@ -282,7 +282,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer {
private File basedir; private File basedir;
/** /**
* Delay in seconds between the invocation of backgroundProcess methods. * Delay in seconds between the invocation of backgroundProcess methods.
*/ */
private int backgroundProcessorDelay = 30; // seconds private int backgroundProcessorDelay = 30; // seconds
@ -292,7 +292,7 @@ public class ServerProperties implements EmbeddedServletContainerCustomizer {
private int maxThreads = 0; // Number of threads in protocol handler private int maxThreads = 0; // Number of threads in protocol handler
/** /**
* Maximum size in bytes of the HTTP message header. * Maximum size in bytes of the HTTP message header.
*/ */
private int maxHttpHeaderSize = 0; // bytes private int maxHttpHeaderSize = 0; // bytes

@ -28,7 +28,6 @@ import org.junit.After;
import org.junit.Rule; import org.junit.Rule;
import org.junit.Test; import org.junit.Test;
import org.junit.rules.ExpectedException; import org.junit.rules.ExpectedException;
import org.springframework.boot.SpringApplication; import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration;
import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.builder.SpringApplicationBuilder;
@ -99,7 +98,8 @@ public class BasicErrorControllerDirectMockMvcTests {
@Test @Test
public void errorPageNotAvailableWithWhitelabelDisabled() throws Exception { public void errorPageNotAvailableWithWhitelabelDisabled() throws Exception {
setup((ConfigurableWebApplicationContext) new SpringApplication( setup((ConfigurableWebApplicationContext) new SpringApplication(
WebMvcIncludedConfiguration.class).run("--server.port=0", "--error.whitelabel.enabled=false")); WebMvcIncludedConfiguration.class).run("--server.port=0",
"--error.whitelabel.enabled=false"));
thrown.expect(ServletException.class); thrown.expect(ServletException.class);
this.mockMvc.perform(get("/error").accept(MediaType.TEXT_HTML)); this.mockMvc.perform(get("/error").accept(MediaType.TEXT_HTML));

@ -16,10 +16,6 @@
package org.springframework.boot.autoconfigure.web; package org.springframework.boot.autoconfigure.web;
import static org.junit.Assert.assertTrue;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import java.lang.annotation.Documented; import java.lang.annotation.Documented;
import java.lang.annotation.ElementType; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
@ -45,6 +41,10 @@ import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.WebApplicationContext;
import static org.junit.Assert.assertTrue;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/** /**
* @author Dave Syer * @author Dave Syer
*/ */

@ -36,7 +36,8 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter {
private final List<? extends FilterableDependency> filters; private final List<? extends FilterableDependency> filters;
/** /**
* Create a new instance with the list of {@link FilterableDependency} instance(s) to use. * Create a new instance with the list of {@link FilterableDependency} instance(s) to
* use.
*/ */
public DependencyFilter(List<? extends FilterableDependency> dependencies) { public DependencyFilter(List<? extends FilterableDependency> dependencies) {
this.filters = dependencies; this.filters = dependencies;
@ -58,8 +59,8 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter {
/** /**
* Check if the specified {@link org.apache.maven.artifact.Artifact} matches the * Check if the specified {@link org.apache.maven.artifact.Artifact} matches the
* specified {@link org.springframework.boot.maven.FilterableDependency}. Returns {@code true} * specified {@link org.springframework.boot.maven.FilterableDependency}. Returns
* if it should be excluded * {@code true} if it should be excluded
*/ */
protected final boolean equals(Artifact artifact, FilterableDependency dependency) { protected final boolean equals(Artifact artifact, FilterableDependency dependency) {
if (!dependency.getGroupId().equals(artifact.getGroupId())) { if (!dependency.getGroupId().equals(artifact.getGroupId())) {

@ -262,7 +262,8 @@ public class PropertiesConfigurationFactory<T> implements FactoryBean<T>,
} }
} }
} }
PropertyNamePatternsMatcher patterns = new DefaultPropertyNamePatternsMatcher(names); PropertyNamePatternsMatcher patterns = new DefaultPropertyNamePatternsMatcher(
names);
PropertyValues propertyValues = (this.properties != null ? new MutablePropertyValues( PropertyValues propertyValues = (this.properties != null ? new MutablePropertyValues(
this.properties) : new PropertySourcesPropertyValues( this.properties) : new PropertySourcesPropertyValues(

@ -48,9 +48,9 @@ public class PropertySourcesPropertyValues implements PropertyValues {
private final PropertySources propertySources; private final PropertySources propertySources;
private static final Collection<String> PATTERN_MATCHED_PROPERTY_SOURCES = Arrays.asList( private static final Collection<String> PATTERN_MATCHED_PROPERTY_SOURCES = Arrays
StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, .asList(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME); StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME);
/** /**
* Create a new PropertyValues from the given PropertySources * Create a new PropertyValues from the given PropertySources
@ -70,7 +70,8 @@ public class PropertySourcesPropertyValues implements PropertyValues {
*/ */
public PropertySourcesPropertyValues(PropertySources propertySources, public PropertySourcesPropertyValues(PropertySources propertySources,
Collection<String> includePatterns, Collection<String> names) { Collection<String> includePatterns, Collection<String> names) {
this(propertySources, new SimplePropertyNamePatternsMatcher(includePatterns), names); this(propertySources, new SimplePropertyNamePatternsMatcher(includePatterns),
names);
} }
/** /**

Loading…
Cancel
Save