diff --git a/spring-boot-docs/pom.xml b/spring-boot-docs/pom.xml index 5f81fc8392..c1f9ad7599 100644 --- a/spring-boot-docs/pom.xml +++ b/spring-boot-docs/pom.xml @@ -65,6 +65,16 @@ jackson-databind true + + com.fasterxml.jackson.datatype + jackson-datatype-joda + true + + + com.fasterxml.jackson.dataformat + jackson-dataformat-xml + true + com.google.code.gson gson @@ -75,46 +85,148 @@ json-simple true + + com.hazelcast + hazelcast + true + + + com.hazelcast + hazelcast-spring + true + com.samskivert jmustache true + + com.sendgrid + sendgrid-java + true + + + com.timgroup + java-statsd-client + true + + + com.zaxxer + HikariCP + true + + + commons-dbcp + commons-dbcp + true + + + org.apache.commons + commons-pool2 + true + io.dropwizard.metrics metrics-core true + + io.projectreactor.spring + reactor-spring-context + true + io.undertow undertow-servlet true + + + jboss-servlet-api_3.1_spec + org.jboss.spec.javax.servlet + + + + + io.undertow + undertow-websockets-jsr + true + + + undertow-servlet + io.undertow + + javax.jms jms-api true + + javax.mail + javax.mail-api + true + javax.servlet javax.servlet-api true + + junit + junit + true + log4j log4j true - - org.apache.logging.log4j - log4j-api - true - - - org.apache.logging.log4j - log4j-core - true - + + net.sf.ehcache + ehcache + true + + + nz.net.ultraq.thymeleaf + thymeleaf-layout-dialect + true + + + org.apache.activemq + activemq-client + true + + + org.apache.activemq + artemis-jms-client + true + + + org.apache.activemq + activemq-jms-pool + true + + + org.apache.activemq + artemis-jms-server + true + + + org.apache.activemq + activemq-pool + true + + + org.apache.logging.log4j + log4j-api + true + + + org.apache.logging.log4j + log4j-core + true + org.apache.httpcomponents httpclient @@ -135,6 +247,21 @@ tomcat-embed-logging-juli true + + org.apache.tomcat + tomcat-jdbc + true + + + org.apache.velocity + velocity + true + + + org.apache.velocity + velocity-tools + true + org.codehaus.btm btm @@ -150,10 +277,21 @@ groovy-xml true + + org.codehaus.groovy + groovy-templates + true + org.crashub crash.shell true + + + groovy-all + org.codehaus.groovy + + org.eclipse.jetty @@ -170,11 +308,21 @@ jetty-webapp true + + org.eclipse.jetty.websocket + javax-websocket-server-impl + true + org.flywaydb flyway-core true + + org.glassfish.jersey.containers + jersey-container-servlet-core + true + org.hibernate hibernate-entitymanager @@ -190,6 +338,21 @@ hornetq-jms-server true + + org.infinispan + infinispan-jcache + true + + + org.infinispan + infinispan-spring4 + true + + + org.json + json + true + org.jolokia jolokia-core @@ -210,6 +373,16 @@ jul-to-slf4j true + + org.springframework + spring-context-support + true + + + org.springframework + spring-jms + true + org.springframework spring-messaging @@ -255,11 +428,41 @@ spring-cloud-spring-service-connector true + + org.springframework.integration + spring-integration-core + true + + + org.springframework.integration + spring-integration-jmx + true + org.springframework.security spring-security-config true + + org.springframework.session + spring-session + true + + + org.springframework.social + spring-social-facebook + true + + + org.springframework.social + spring-social-linkedin + true + + + org.springframework.social + spring-social-twitter + true + org.springframework.data spring-data-elasticsearch @@ -275,6 +478,11 @@ spring-data-mongodb true + + org.springframework.data + spring-data-redis + true + org.springframework.data spring-data-rest-core @@ -320,11 +528,31 @@ thymeleaf-spring4 true + + org.thymeleaf.extras + thymeleaf-extras-conditionalcomments + true + + + com.github.mxab.thymeleaf.extras + thymeleaf-extras-data-attribute + true + + + org.thymeleaf.extras + thymeleaf-extras-springsecurity4 + true + org.yaml snakeyaml true + + redis.clients + jedis + true + diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java index c193ecd47f..7cb01ef7e8 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java @@ -60,7 +60,7 @@ public abstract class FileUtils { * Generate a SHA.1 Hash for a given file. * @param file the file to hash * @return the hash value as a String - * @throws IOException + * @throws IOException if the file cannot be read */ public static String sha1Hash(File file) throws IOException { try { diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarWriter.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarWriter.java index aa51cfbb00..0210e4339e 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarWriter.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarWriter.java @@ -62,8 +62,8 @@ public class JarWriter { /** * Create a new {@link JarWriter} instance. * @param file the file to write - * @throws IOException - * @throws FileNotFoundException + * @throws IOException if the file cannot be opened + * @throws FileNotFoundException if the file cannot be found */ public JarWriter(File file) throws FileNotFoundException, IOException { this(file, null); @@ -73,8 +73,8 @@ public class JarWriter { * Create a new {@link JarWriter} instance. * @param file the file to write * @param launchScript an optional launch script to prepend to the front of the jar - * @throws IOException - * @throws FileNotFoundException + * @throws IOException if the file cannot be opened + * @throws FileNotFoundException if the file cannot be found */ public JarWriter(File file, LaunchScript launchScript) throws FileNotFoundException, IOException { @@ -102,7 +102,7 @@ public class JarWriter { /** * Write the specified manifest. * @param manifest the manifest to write - * @throws IOException + * @throws IOException of the manifest cannot be written */ public void writeManifest(final Manifest manifest) throws IOException { JarEntry entry = new JarEntry("META-INF/MANIFEST.MF"); @@ -117,7 +117,7 @@ public class JarWriter { /** * Write all entries from the specified jar file. * @param jarFile the source jar file - * @throws IOException + * @throws IOException if the entries cannot be written */ public void writeEntries(JarFile jarFile) throws IOException { Enumeration entries = jarFile.entries(); @@ -194,7 +194,7 @@ public class JarWriter { /** * Write the required spring-boot-loader classes to the JAR. - * @throws IOException + * @throws IOException if the classes cannot be written */ public void writeLoaderClasses() throws IOException { URL loaderJar = getClass().getClassLoader().getResource(NESTED_LOADER_JAR); @@ -211,7 +211,7 @@ public class JarWriter { /** * Close the writer. - * @throws IOException + * @throws IOException if the file cannot be closed */ public void close() throws IOException { this.jarOutput.close(); diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Libraries.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Libraries.java index 65763f2078..07bb931f2d 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Libraries.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Libraries.java @@ -37,7 +37,7 @@ public interface Libraries { /** * Iterate all relevant libraries. * @param callback a callback for each relevant library. - * @throws IOException + * @throws IOException if the operation fails */ void doWithLibraries(LibraryCallback callback) throws IOException; diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/LibraryCallback.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/LibraryCallback.java index 23df662154..bea098d22a 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/LibraryCallback.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/LibraryCallback.java @@ -29,7 +29,7 @@ public interface LibraryCallback { /** * Callback to for a single library backed by a {@link File}. * @param library the library - * @throws IOException + * @throws IOException if the operation fails */ void library(Library library) throws IOException; diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/MainClassFinder.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/MainClassFinder.java index 77af5d9ca7..9b483cf87c 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/MainClassFinder.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/MainClassFinder.java @@ -76,7 +76,7 @@ public abstract class MainClassFinder { * Find the main class from a given folder. * @param rootFolder the root folder to search * @return the main class or {@code null} - * @throws IOException + * @throws IOException if the folder cannot be read */ public static String findMainClass(File rootFolder) throws IOException { return doWithMainClasses(rootFolder, new ClassNameCallback() { @@ -91,7 +91,7 @@ public abstract class MainClassFinder { * Find a single main class from a given folder. * @param rootFolder the root folder to search * @return the main class or {@code null} - * @throws IOException + * @throws IOException if the folder cannot be read */ public static String findSingleMainClass(File rootFolder) throws IOException { MainClassesCallback callback = new MainClassesCallback(); @@ -161,7 +161,7 @@ public abstract class MainClassFinder { * @param jarFile the jar file to search * @param classesLocation the location within the jar containing classes * @return the main class or {@code null} - * @throws IOException + * @throws IOException if the jar file cannot be read */ public static String findMainClass(JarFile jarFile, String classesLocation) throws IOException { @@ -179,7 +179,7 @@ public abstract class MainClassFinder { * @param jarFile the jar file to search * @param classesLocation the location within the jar containing classes * @return the main class or {@code null} - * @throws IOException + * @throws IOException if the jar file cannot be read */ public static String findSingleMainClass(JarFile jarFile, String classesLocation) throws IOException { diff --git a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java index b79c9b84b3..5ce761b7f6 100644 --- a/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java +++ b/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java @@ -90,7 +90,7 @@ public class Repackager { /** * Repackage the source file so that it can be run using '{@literal java -jar}' * @param libraries the libraries required to run the archive - * @throws IOException + * @throws IOException if the file cannot be repackaged */ public void repackage(Libraries libraries) throws IOException { repackage(this.source, libraries); @@ -101,7 +101,7 @@ public class Repackager { * {@literal java -jar}' * @param destination the destination file (may be the same as the source) * @param libraries the libraries required to run the archive - * @throws IOException + * @throws IOException if the file cannot be repackaged */ public void repackage(File destination, Libraries libraries) throws IOException { repackage(destination, libraries, null); @@ -113,7 +113,7 @@ public class Repackager { * @param destination the destination file (may be the same as the source) * @param libraries the libraries required to run the archive * @param launchScript an optional launch script prepended to the front of the jar - * @throws IOException + * @throws IOException if the file cannot be repackaged * @since 1.3.0 */ public void repackage(File destination, Libraries libraries, LaunchScript launchScript) diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java index d86c658518..18e6ab2a9e 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java @@ -119,7 +119,7 @@ public abstract class ExecutableArchiveLauncher extends Launcher { * Called to post-process archive entries before they are used. Implementations can * add and remove entries. * @param archives the archives - * @throws Exception + * @throws Exception if the post processing fails */ protected void postProcessClassPathArchives(List archives) throws Exception { } diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java index 770a086a66..661727ccf9 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java @@ -70,7 +70,7 @@ public abstract class Launcher { * Create a classloader for the specified archives. * @param archives the archives * @return the classloader - * @throws Exception + * @throws Exception if the classloader cannot be created */ protected ClassLoader createClassLoader(List archives) throws Exception { List urls = new ArrayList(archives.size()); @@ -86,7 +86,7 @@ public abstract class Launcher { * Create a classloader for the specified URLs * @param urls the URLs * @return the classloader - * @throws Exception + * @throws Exception if the classloader cannot be created */ protected ClassLoader createClassLoader(URL[] urls) throws Exception { return new LaunchedURLClassLoader(urls, getClass().getClassLoader()); @@ -97,7 +97,7 @@ public abstract class Launcher { * @param args the incoming arguments * @param mainClass the main class to run * @param classLoader the classloader - * @throws Exception + * @throws Exception if the launch fails */ protected void launch(String[] args, String mainClass, ClassLoader classLoader) throws Exception { @@ -114,7 +114,7 @@ public abstract class Launcher { * @param args the incoming arguments * @param classLoader the classloader * @return a runnable used to start the application - * @throws Exception + * @throws Exception if the main method runner cannot be created */ protected Runnable createMainMethodRunner(String mainClass, String[] args, ClassLoader classLoader) throws Exception { @@ -127,14 +127,14 @@ public abstract class Launcher { /** * Returns the main class that should be launched. * @return the name of the main class - * @throws Exception + * @throws Exception if the main class cannot be obtained */ protected abstract String getMainClass() throws Exception; /** * Returns the archives that will be used to construct the class path. * @return the class path archives - * @throws Exception + * @throws Exception if the class path archives cannot be obtained */ protected abstract List getClassPathArchives() throws Exception; diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java index 8c881358dc..11abd78ec4 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java @@ -37,7 +37,7 @@ public abstract class Archive { /** * Returns a URL that can be used to load the archive. * @return the archive URL - * @throws MalformedURLException + * @throws MalformedURLException if the URL is malformed */ public abstract URL getUrl() throws MalformedURLException; @@ -45,7 +45,7 @@ public abstract class Archive { * Obtain the main class that should be used to launch the application. By default * this method uses a {@code Start-Class} manifest entry. * @return the main class - * @throws Exception + * @throws Exception if the main class cannot be obtained */ public String getMainClass() throws Exception { Manifest manifest = getManifest(); @@ -73,7 +73,7 @@ public abstract class Archive { /** * Returns the manifest of the archive. * @return the manifest - * @throws IOException + * @throws IOException if the manifest cannot be read */ public abstract Manifest getManifest() throws IOException; @@ -87,7 +87,7 @@ public abstract class Archive { * Returns nested {@link Archive}s for entries that match the specified filter. * @param filter the filter used to limit entries * @return nested archives - * @throws IOException + * @throws IOException if nested archives cannot be read */ public abstract List getNestedArchives(EntryFilter filter) throws IOException; @@ -96,7 +96,7 @@ public abstract class Archive { * Returns a filtered version of the archive. * @param filter the filter to apply * @return a filter archive - * @throws IOException + * @throws IOException if the archive cannot be read */ public abstract Archive getFilteredArchive(EntryRenameFilter filter) throws IOException; diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessData.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessData.java index 6ebd7f123d..c941bc23c9 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessData.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessData.java @@ -32,7 +32,7 @@ public interface RandomAccessData { * caller is responsible close the underlying stream. * @param access hint indicating how the underlying data should be accessed * @return a new input stream that can be used to read the underlying data. - * @throws IOException + * @throws IOException if the stream cannot be opened */ InputStream getInputStream(ResourceAccess access) throws IOException; diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java index adc3bde0b2..15aad986a6 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java @@ -100,7 +100,7 @@ public final class JarEntryData { * @return the underlying {@link RandomAccessData} for this entry. Generally this * method should not be called directly and instead data should be accessed via * {@link JarFile#getInputStream(ZipEntry)}. - * @throws IOException + * @throws IOException if the data cannot be read */ public RandomAccessData getData() throws IOException { if (this.data == null) { diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarFile.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarFile.java index bb838ca995..50ab249747 100644 --- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarFile.java +++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarFile.java @@ -89,7 +89,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable *
    *
  • {@link Class} - A Java class to be loaded by {@link AnnotatedBeanDefinitionReader}
  • * 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 5f8f425749..6ba21b4c84 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 @@ -405,7 +405,7 @@ public class SpringApplicationBuilder { /** * Default properties for the environment. Multiple calls to this method are * cumulative. - * @param defaults + * @param defaults the default properties * @return the current builder * @see SpringApplicationBuilder#properties(String...) */ diff --git a/spring-boot/src/main/java/org/springframework/boot/context/ContextIdApplicationContextInitializer.java b/spring-boot/src/main/java/org/springframework/boot/context/ContextIdApplicationContextInitializer.java index 319d990499..e748511346 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/ContextIdApplicationContextInitializer.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/ContextIdApplicationContextInitializer.java @@ -68,7 +68,8 @@ public class ContextIdApplicationContextInitializer implements } /** - * @param name + * Create a new {@link ContextIdApplicationContextInitializer} instance. + * @param name the name of the application (can include placeholders) */ public ContextIdApplicationContextInitializer(String name) { this.name = name; @@ -91,7 +92,6 @@ public class ContextIdApplicationContextInitializer implements private String getApplicationId(ConfigurableEnvironment environment) { String name = environment.resolvePlaceholders(this.name); String index = environment.resolvePlaceholders(INDEX_PATTERN); - String profiles = StringUtils.arrayToCommaDelimitedString(environment .getActiveProfiles()); if (StringUtils.hasText(profiles)) { diff --git a/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBindingPostProcessor.java b/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBindingPostProcessor.java index 8ce9f32c8f..25f83e8227 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBindingPostProcessor.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBindingPostProcessor.java @@ -114,28 +114,32 @@ public class ConfigurationPropertiesBindingPostProcessor implements BeanPostProc } /** - * @param propertySources + * Set the property sources to bind. + * @param propertySources the property sources */ public void setPropertySources(PropertySources propertySources) { this.propertySources = propertySources; } /** - * @param validator the validator to set + * Set the bean validator used to validate property fields. + * @param validator the validator */ public void setValidator(Validator validator) { this.validator = validator; } /** - * @param conversionService the conversionService to set + * Set the conversion service used to convert property values. + * @param conversionService the conversion service */ public void setConversionService(ConversionService conversionService) { this.conversionService = conversionService; } /** - * @param beans the bean meta data to set + * Set the bean meta-data store. + * @param beans the bean meta data store */ public void setBeanMetaDataStore(ConfigurationBeanFactoryMetaData beans) { this.beans = beans; @@ -163,11 +167,9 @@ public class ConfigurationPropertiesBindingPostProcessor implements BeanPostProc @Override public void afterPropertiesSet() throws Exception { - if (this.propertySources == null) { this.propertySources = deducePropertySources(); } - if (this.validator == null) { this.validator = getOptionalBean(VALIDATOR_BEAN_NAME, Validator.class); if (this.validator == null && isJsr303Present()) { @@ -176,7 +178,6 @@ public class ConfigurationPropertiesBindingPostProcessor implements BeanPostProc this.ownedValidator = true; } } - if (this.conversionService == null) { this.conversionService = getOptionalBean( ConfigurableApplicationContext.CONVERSION_SERVICE_BEAN_NAME, diff --git a/spring-boot/src/main/java/org/springframework/boot/context/properties/EnableConfigurationProperties.java b/spring-boot/src/main/java/org/springframework/boot/context/properties/EnableConfigurationProperties.java index 15f1ab685f..e51433e18f 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/properties/EnableConfigurationProperties.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/properties/EnableConfigurationProperties.java @@ -42,6 +42,7 @@ public @interface EnableConfigurationProperties { /** * Convenient way to quickly register {@link ConfigurationProperties} beans with * Spring. Standard Spring Beans will also be scanned regardless of this value. + * @return {@link ConfigurationProperties} beans to register */ Class[] value() default {}; diff --git a/spring-boot/src/main/java/org/springframework/boot/env/PropertySourceLoader.java b/spring-boot/src/main/java/org/springframework/boot/env/PropertySourceLoader.java index aa2b5d21f4..f453a8a515 100644 --- a/spring-boot/src/main/java/org/springframework/boot/env/PropertySourceLoader.java +++ b/spring-boot/src/main/java/org/springframework/boot/env/PropertySourceLoader.java @@ -45,7 +45,7 @@ public interface PropertySourceLoader { * used to load multi-document files (such as YAML). Simple property formats should * {@code null} when asked to load a profile. * @return a property source or {@code null} - * @throws IOException + * @throws IOException if the source cannot be loaded */ PropertySource load(String name, Resource resource, String profile) throws IOException; diff --git a/spring-boot/src/main/java/org/springframework/boot/env/PropertySourcesLoader.java b/spring-boot/src/main/java/org/springframework/boot/env/PropertySourcesLoader.java index c3942851cf..3abfeeff91 100644 --- a/spring-boot/src/main/java/org/springframework/boot/env/PropertySourcesLoader.java +++ b/spring-boot/src/main/java/org/springframework/boot/env/PropertySourcesLoader.java @@ -69,7 +69,7 @@ public class PropertySourcesLoader { * Load the specified resource (if possible) and add it as the first source. * @param resource the source resource (may be {@code null}). * @return the loaded property source or {@code null} - * @throws IOException + * @throws IOException if the source cannot be loaded */ public PropertySource load(Resource resource) throws IOException { return load(resource, null); @@ -81,7 +81,7 @@ public class PropertySourcesLoader { * @param resource the source resource (may be {@code null}). * @param profile a specific profile to load or {@code null} to load the default. * @return the loaded property source or {@code null} - * @throws IOException + * @throws IOException if the source cannot be loaded */ public PropertySource load(Resource resource, String profile) throws IOException { return load(resource, resource.getDescription(), profile); @@ -94,7 +94,7 @@ public class PropertySourcesLoader { * @param name the root property name (may be {@code null}). * @param profile a specific profile to load or {@code null} to load the default. * @return the loaded property source or {@code null} - * @throws IOException + * @throws IOException if the source cannot be loaded */ public PropertySource load(Resource resource, String name, String profile) throws IOException { @@ -115,7 +115,7 @@ public class PropertySourcesLoader { * @param name the root property name (may be {@code null}). * @param profile a specific profile to load or {@code null} to load the default. * @return the loaded property source or {@code null} - * @throws IOException + * @throws IOException if the source cannot be loaded */ public PropertySource load(Resource resource, String group, String name, String profile) throws IOException { diff --git a/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java b/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java index 5222846035..aee38163de 100644 --- a/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java +++ b/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java @@ -118,7 +118,7 @@ public class AtomikosProperties { /** * Specifies whether VM shutdown should trigger forced shutdown of the transaction * core. Defaults to false. - * @param forceShutdownOnVmExit + * @param forceShutdownOnVmExit if VM shutdown should be forced */ public void setForceShutdownOnVmExit(boolean forceShutdownOnVmExit) { set("force_shutdown_on_vm_exit", forceShutdownOnVmExit); diff --git a/spring-boot/src/main/java/org/springframework/boot/orm/jpa/EntityScan.java b/spring-boot/src/main/java/org/springframework/boot/orm/jpa/EntityScan.java index 7b179fb309..95f3391658 100644 --- a/spring-boot/src/main/java/org/springframework/boot/orm/jpa/EntityScan.java +++ b/spring-boot/src/main/java/org/springframework/boot/orm/jpa/EntityScan.java @@ -53,16 +53,17 @@ public @interface EntityScan { * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation * declarations e.g.: {@code @EntityScan("org.my.pkg")} instead of * {@code @EntityScan(basePackages="org.my.pkg")}. + * @return the base packages to scan */ String[] value() default {}; /** - * Base packages to scan for annotated entities. - *

    - * {@link #value()} is an alias for (and mutually exclusive with) this attribute. + * Base packages to scan for annotated entities. {@link #value()} is an alias for (and + * mutually exclusive with) this attribute. *

    * Use {@link #basePackageClasses()} for a type-safe alternative to String-based * package names. + * @return the base packages to scan */ String[] basePackages() default {}; @@ -72,6 +73,7 @@ public @interface EntityScan { *

    * Consider creating a special no-op marker class or interface in each package that * serves no purpose other than being referenced by this attribute. + * @return classes form the base packages to scan */ Class[] basePackageClasses() default {}; diff --git a/spring-boot/src/main/java/org/springframework/boot/test/IntegrationTest.java b/spring-boot/src/main/java/org/springframework/boot/test/IntegrationTest.java index 2a2d14c478..b1726e059b 100644 --- a/spring-boot/src/main/java/org/springframework/boot/test/IntegrationTest.java +++ b/spring-boot/src/main/java/org/springframework/boot/test/IntegrationTest.java @@ -56,6 +56,7 @@ public @interface IntegrationTest { /** * Properties in form {@literal key=value} that should be added to the Spring * {@link Environment} before the test runs. + * @return the environment properties */ String[] value() default {}; diff --git a/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationConfiguration.java b/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationConfiguration.java index bfb75784c0..f78addce2d 100644 --- a/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationConfiguration.java +++ b/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationConfiguration.java @@ -45,31 +45,37 @@ public @interface SpringApplicationConfiguration { /** * @see ContextConfiguration#locations() + * @return the context configuration locations */ String[] locations() default {}; /** * @see ContextConfiguration#classes() + * @return the context configuration classes */ Class[] classes() default {}; /** * @see ContextConfiguration#initializers() + * @return the context configuration initializers */ Class>[] initializers() default {}; /** * @see ContextConfiguration#inheritLocations() + * @return if context locations should be inherited */ boolean inheritLocations() default true; /** * @see ContextConfiguration#inheritInitializers() + * @return if context initializers should be inherited */ boolean inheritInitializers() default true; /** * @see ContextConfiguration#name() + * @return if context configuration name */ String name() default ""; diff --git a/spring-boot/src/main/java/org/springframework/boot/test/WebIntegrationTest.java b/spring-boot/src/main/java/org/springframework/boot/test/WebIntegrationTest.java index b1b8ecfcfd..2231079425 100644 --- a/spring-boot/src/main/java/org/springframework/boot/test/WebIntegrationTest.java +++ b/spring-boot/src/main/java/org/springframework/boot/test/WebIntegrationTest.java @@ -49,6 +49,7 @@ public @interface WebIntegrationTest { /** * Properties in form {@literal key=value} that should be added to the Spring * {@link Environment} before the test runs. + * @return properties to add to the context */ String[] value() default {}; @@ -57,6 +58,7 @@ public @interface WebIntegrationTest { * {@link Environment} property which usually triggers listening on a random port. * Often used in conjunction with a @Value("${local.server.port}") * injected field on the test. + * @return if a random port should be used */ boolean randomPort() default false;