From 719b47fad8e19e3235dc63af11b8f688fa72b1bb Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 13 Jan 2014 22:54:37 -0800 Subject: [PATCH] Polish --- .../builder/SpringApplicationBuilder.java | 36 +++---------------- .../SpringApplicationBuilderTests.java | 4 ++- 2 files changed, 7 insertions(+), 33 deletions(-) diff --git a/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java b/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java index 52417ccdb3..3e1d7e8806 100644 --- a/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java +++ b/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java @@ -87,7 +87,6 @@ public class SpringApplicationBuilder { /** * Accessor for the current application context. - * * @return the current application context (or null if not yet running) */ public ConfigurableApplicationContext context() { @@ -96,7 +95,6 @@ public class SpringApplicationBuilder { /** * Accessor for the current application. - * * @return the current application (never null) */ public SpringApplication application() { @@ -107,7 +105,6 @@ public class SpringApplicationBuilder { * Create an application context (and its parent if specified) with the command line * args provided. The parent is run first with the same arguments if has not yet been * started. - * * @param args the command line arguments * @return an application context created from the current state */ @@ -140,7 +137,6 @@ public class SpringApplicationBuilder { /** * Create a child application with the provided sources. Default args and environment * are copied down into the child, but everything else is a clean sheet. - * * @param sources the sources for the application (Spring configuration) * @return the child application builder */ @@ -172,7 +168,6 @@ public class SpringApplicationBuilder { /** * Add a parent application with the provided sources. Default args and environment * are copied up into the parent, but everything else is a clean sheet. - * * @param sources the sources for the application (Spring configuration) * @return the parent builder */ @@ -200,7 +195,6 @@ public class SpringApplicationBuilder { /** * Add an already running parent context to an existing application. - * * @param parent the parent context * @return the current builder (not the parent) */ @@ -215,9 +209,7 @@ public class SpringApplicationBuilder { /** * Create a sibling application (one with the same parent). A side effect of calling * this method is that the current application (and its parent) are started. - * * @param sources the sources for the application (Spring configuration) - * * @return the new sibling builder */ public SpringApplicationBuilder sibling(Object... sources) { @@ -228,11 +220,9 @@ public class SpringApplicationBuilder { * Create a sibling application (one with the same parent). A side effect of calling * this method is that the current application (and its parent) are started if they * are not already running. - * * @param sources the sources for the application (Spring configuration) * @param args the command line arguments to use when starting the current app and its * parent - * * @return the new sibling builder */ public SpringApplicationBuilder sibling(Object[] sources, String... args) { @@ -241,7 +231,6 @@ public class SpringApplicationBuilder { /** * Explicitly set the context class to be used. - * * @param cls the context class to use * @return the current builder */ @@ -253,7 +242,6 @@ public class SpringApplicationBuilder { /** * Add more sources to use in this application. - * * @param sources the sources to add * @return the current builder */ @@ -264,7 +252,6 @@ public class SpringApplicationBuilder { /** * Add more sources (configuration classes and components) to this application - * * @param sources the sources to add * @return the current builder */ @@ -276,7 +263,6 @@ public class SpringApplicationBuilder { /** * Flag to explicitly request a web or non-web environment (auto detected based on * classpath if not set). - * * @param webEnvironment the flag to set * @return the current builder */ @@ -287,7 +273,6 @@ public class SpringApplicationBuilder { /** * Flag to indicate the startup information should be logged. - * * @param logStartupInfo the flag to set. Default true. * @return the current builder */ @@ -298,7 +283,6 @@ public class SpringApplicationBuilder { /** * Flag to indicate the startup banner should be printed. - * * @param showBanner the flag to set. Default true. * @return the current builder */ @@ -320,7 +304,6 @@ public class SpringApplicationBuilder { /** * Fixes the main application class that is used to anchor the startup messages. - * * @param mainApplicationClass the class to use. * @return the current builder */ @@ -331,7 +314,6 @@ public class SpringApplicationBuilder { /** * Flag to indicate that command line arguments should be added to the environment. - * * @param addCommandLineProperties the flag to set. Default true. * @return the current builder */ @@ -342,9 +324,8 @@ public class SpringApplicationBuilder { } /** - * Default properties for the environment in the form key=value or - * key:value. - * + * Default properties for the environment in the form {@code key=value} or + * {@code key:value}. * @param defaultProperties the properties to set. * @return the current builder */ @@ -367,9 +348,8 @@ public class SpringApplicationBuilder { } /** - * Default properties for the environment in the form key=value or - * key:value. - * + * Default properties for the environment in the form {@code key=value} or + * {@code key:value}. * @param defaultProperties the properties to set. * @return the current builder */ @@ -388,10 +368,8 @@ public class SpringApplicationBuilder { /** * Default properties for the environment. Multiple calls to this method are * cumulative. - * * @param defaults * @return the current builder - * * @see SpringApplicationBuilder#properties(String...) */ public SpringApplicationBuilder properties(Map defaults) { @@ -406,7 +384,6 @@ public class SpringApplicationBuilder { /** * Add to the active Spring profiles for this app (and its parent and children). - * * @param profiles the profiles to add. * @return the current builder */ @@ -426,7 +403,6 @@ public class SpringApplicationBuilder { /** * Bean name generator for automatically generated bean names in the application * context. - * * @param beanNameGenerator the generator to set. * @return the current builder */ @@ -437,7 +413,6 @@ public class SpringApplicationBuilder { /** * Environment for the application context. - * * @param environment the environment to set. * @return the current builder */ @@ -450,7 +425,6 @@ public class SpringApplicationBuilder { /** * {@link ResourceLoader} for the application context. If a custom class loader is * needed, this is where it would be added. - * * @param resourceLoader the resource loader to set. * @return the current builder */ @@ -462,7 +436,6 @@ public class SpringApplicationBuilder { /** * Add some initializers to the application (applied to the {@link ApplicationContext} * before any bean definitions are loaded). - * * @param initializers some initializers to add * @return the current builder */ @@ -482,7 +455,6 @@ public class SpringApplicationBuilder { /** * Add some initializers to the application (applied to the {@link ApplicationContext} * before any bean definitions are loaded). - * * @param listeners some listeners to add * @return the current builder */ diff --git a/spring-boot/src/test/java/org/springframework/boot/builder/SpringApplicationBuilderTests.java b/spring-boot/src/test/java/org/springframework/boot/builder/SpringApplicationBuilderTests.java index 857684bb19..f1847df3dd 100644 --- a/spring-boot/src/test/java/org/springframework/boot/builder/SpringApplicationBuilderTests.java +++ b/spring-boot/src/test/java/org/springframework/boot/builder/SpringApplicationBuilderTests.java @@ -42,6 +42,8 @@ import static org.mockito.Mockito.spy; import static org.mockito.Mockito.verify; /** + * Tests for {@link SpringApplicationBuilder}. + * * @author Dave Syer */ public class SpringApplicationBuilderTests { @@ -236,4 +238,4 @@ public class SpringApplicationBuilderTests { } } -} \ No newline at end of file +}