Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish Javadoc

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-tools/spring-boot-antlib/src/main/java/org/springframework/boot/ant/FindMainClass.java
View File

@@ -90,7 +90,7 @@ public class FindMainClass extends Task {
/**
* Set the main class, which will cause the search to be bypassed.
* @param mainClass
* @param mainClass the main class name
*/
public void setMainClass(String mainClass) {
this.mainClass = mainClass;
@@ -98,15 +98,15 @@ public class FindMainClass extends Task {
/**
* Set the root location of classes to be searched.
* @param classesRoot
* @param classesRoot the root location
*/
public void setClassesRoot(File classesRoot) {
this.classesRoot = classesRoot;
}
/**
* Set the property to set (if unset, result will be printed to the log).
* @param property
* Set the ANT property to set (if left unset, result will be printed to the log).
* @param property the ANT property to set
*/
public void setProperty(String property) {
this.property = property;

7
spring-boot-tools/spring-boot-configuration-metadata/src/main/java/org/springframework/boot/configurationmetadata/ConfigurationMetadataRepositoryJsonBuilder.java
View File

@@ -34,6 +34,9 @@ import org.json.JSONException;
*/
public final class ConfigurationMetadataRepositoryJsonBuilder {
/**
* UTF-8 Charset.
*/
public static final Charset UTF_8 = Charset.forName("UTF-8");
private Charset defaultCharset = UTF_8;
@@ -54,7 +57,7 @@ public final class ConfigurationMetadataRepositoryJsonBuilder {
* Leaves the stream open when done.
* @param inputStream the source input stream
* @return this builder
* @throws IOException
* @throws IOException in case of I/O errors
*/
public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(
InputStream inputStream) throws IOException {
@@ -71,7 +74,7 @@ public final class ConfigurationMetadataRepositoryJsonBuilder {
* @param inputstream the source input stream
* @param charset the charset of the input
* @return this builder
* @throws IOException
* @throws IOException in case of I/O errors
*/
public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(
InputStream inputstream, Charset charset) throws IOException {

2
spring-boot-tools/spring-boot-configuration-metadata/src/main/java/org/springframework/boot/configurationmetadata/ConfigurationMetadataSource.java
View File

@@ -45,7 +45,7 @@ public class ConfigurationMetadataSource implements Serializable {
private final Map<String, ConfigurationMetadataProperty> properties = new HashMap<String, ConfigurationMetadataProperty>();
/**
* The identifier of the group to which this source is associated
* The identifier of the group to which this source is associated.
* @return the group id
*/
public String getGroupId() {

2
spring-boot-tools/spring-boot-configuration-metadata/src/main/java/org/springframework/boot/configurationmetadata/JsonReader.java
View File

@@ -28,7 +28,7 @@ import org.json.JSONArray;
import org.json.JSONObject;
/**
* Read standard json metadata format as {@link ConfigurationMetadataRepository}
* Read standard json metadata format as {@link ConfigurationMetadataRepository}.
*
* @author Stephane Nicoll
* @since 1.3.0

1
spring-boot-tools/spring-boot-configuration-metadata/src/main/java/org/springframework/boot/configurationmetadata/RawConfigurationMetadata.java
View File

@@ -66,6 +66,7 @@ class RawConfigurationMetadata {
/**
* Resolve the name of an item against this instance.
* @param item the item to resolve
* @see ConfigurationMetadataProperty#setName(String)
*/
private void resolveName(ConfigurationMetadataItem item) {

2
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/MetadataStore.java
View File

@@ -33,7 +33,7 @@ import org.springframework.boot.configurationprocessor.metadata.InvalidConfigura
import org.springframework.boot.configurationprocessor.metadata.JsonMarshaller;
/**
* A {@code MetadataStore} is responsible for the storage of metadata on the filesystem
* A {@code MetadataStore} is responsible for the storage of metadata on the filesystem.
*
* @author Andy Wilkinson
* @since 1.2.2

3
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/fieldvalues/javac/JavaCompilerFieldValuesParser.java
View File

@@ -54,6 +54,9 @@ public class JavaCompilerFieldValuesParser implements FieldValuesParser {
return Collections.emptyMap();
}
/**
* {@link TreeVisitor} to collect fields.
*/
private static class FieldCollector implements TreeVisitor {
private static final Map<String, Class<?>> WRAPPER_TYPES;

6
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ConfigurationMetadata.java
View File

@@ -84,14 +84,16 @@ public class ConfigurationMetadata {
}
/**
* @return the meta-data properties.
* Return item meta-data.
* @return the items
*/
public List<ItemMetadata> getItems() {
return flattenValues(this.items);
}
/**
* @return the meta-data hints.
* Return hint meta-data.
* @return the hints
*/
public List<ItemHint> getHints() {
return flattenValues(this.hints);

6
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemHint.java
View File

@@ -88,6 +88,9 @@ public class ItemHint implements Comparable<ItemHint> {
+ ", providers=" + this.providers + '}';
}
/**
* A hint for a value.
*/
public static class ValueHint {
private final Object value;
@@ -115,6 +118,9 @@ public class ItemHint implements Comparable<ItemHint> {
}
/**
* A value provider.
*/
public static class ValueProvider {
private final String name;

12
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemMetadata.java
View File

@@ -172,7 +172,17 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
* The item type.
*/
public enum ItemType {
GROUP, PROPERTY
/**
* Group item type.
*/
GROUP,
/**
* Property item type.
*/
PROPERTY
}
}

4
spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/TestProject.java
View File

@@ -160,7 +160,7 @@ public class TestProject {
/**
* Restore source code of given class to its original contents.
* @param type the class to revert
* @throws IOException
* @throws IOException in case of I/O errors
*/
public void revert(Class<?> type) throws IOException {
Assert.assertTrue(getSourceFile(type).exists());
@@ -170,7 +170,7 @@ public class TestProject {
/**
* Add source code of given class to this project.
* @param type the class to add
* @throws IOException
* @throws IOException in case of I/O errors
*/
public void add(Class<?> type) throws IOException {
Assert.assertFalse(getSourceFile(type).exists());

6
spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/repackage/RepackagePluginFeatures.java
View File

@@ -45,6 +45,9 @@ import org.springframework.util.StringUtils;
*/
public class RepackagePluginFeatures implements PluginFeatures {
/**
* The name of the repackage task.
*/
public static final String REPACKAGE_TASK_NAME = "bootRepackage";
@Override
@@ -97,6 +100,7 @@ public class RepackagePluginFeatures implements PluginFeatures {
/**
* Register BootRepackage so that we can use task {@code foo(type: BootRepackage)}.
* @param project the source project
*/
private void registerRepackageTaskProperty(Project project) {
project.getExtensions().getExtraProperties()
@@ -104,7 +108,7 @@ public class RepackagePluginFeatures implements PluginFeatures {
}
/**
* Register task input/outputs when classifiers are used
* Register task input/outputs when classifiers are used.
*/
private static class RegisterInputsOutputsAction implements Action<Jar> {

8
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarWriter.java
View File

@@ -222,7 +222,7 @@ public class JarWriter {
* delegate to this one.
* @param entry the entry to write
* @param entryWriter the entry writer or {@code null} if there is no content
* @throws IOException
* @throws IOException in case of I/O errors
*/
private void writeEntry(JarEntry entry, EntryWriter entryWriter) throws IOException {
String parent = entry.getName();
@@ -251,9 +251,9 @@ public class JarWriter {
private interface EntryWriter {
/**
* Write entry data to the specified output stream
* Write entry data to the specified output stream.
* @param outputStream the destination for the data
* @throws IOException
* @throws IOException in case of I/O errors
*/
void write(OutputStream outputStream) throws IOException;
@@ -338,7 +338,7 @@ public class JarWriter {
}
/**
* Data holder for CRC and Size
* Data holder for CRC and Size.
*/
private static class CrcAndSize {

2
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JvmUtils.java
View File

@@ -29,7 +29,7 @@ import java.net.URLClassLoader;
abstract class JvmUtils {
/**
* Various search locations for tools, including the odd Java 6 OSX jar
* Various search locations for tools, including the odd Java 6 OSX jar.
*/
private static final String[] TOOLS_LOCATIONS = { "lib/tools.jar",
"../lib/tools.jar", "../Classes/classes.jar" };

2
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Layouts.java
View File

@@ -151,7 +151,7 @@ public final class Layouts {
}
/**
* Module layout (designed to be used as a "plug-in")
* Module layout (designed to be used as a "plug-in").
*/
public static class Module implements Layout {

12
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Library.java
View File

@@ -70,29 +70,33 @@ public class Library {
}
/**
* @return the name of file as it should be written
* Return the name of file as it should be written.
* @return then name.
*/
public String getName() {
return this.name;
}
/**
* @return the library file
* Return the library file.
* @return the file
*/
public File getFile() {
return this.file;
}
/**
* @return the scope of the library
* Return the scope of the library.
* @return the scope
*/
public LibraryScope getScope() {
return this.scope;
}
/**
* @return if the file cannot be used directly as a nested jar and needs to be
* Return if the file cannot be used directly as a nested jar and needs to be
* unpacked.
* @return if unpack is required
*/
public boolean isUnpackRequired() {
return this.unpackRequired;

8
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/MainClassFinder.java
View File

@@ -102,10 +102,11 @@ public abstract class MainClassFinder {
/**
* Perform the given callback operation on all main classes from the given root
* folder.
* @param <T> the result type
* @param rootFolder the root folder
* @param callback the callback
* @return the first callback result or {@code null}
* @throws IOException
* @throws IOException in case of I/O errors
*/
static <T> T doWithMainClasses(File rootFolder, ClassNameCallback<T> callback)
throws IOException {
@@ -190,11 +191,12 @@ public abstract class MainClassFinder {
/**
* Perform the given callback operation on all main classes from the given jar.
* @param <T> the result type
* @param jarFile the jar file to search
* @param classesLocation the location within the jar containing classes
* @param callback the callback
* @return the first callback result or {@code null}
* @throws IOException
* @throws IOException in case of I/O errors
*/
static <T> T doWithMainClasses(JarFile jarFile, String classesLocation,
ClassNameCallback<T> callback) throws IOException {
@@ -316,7 +318,7 @@ public abstract class MainClassFinder {
public interface ClassNameCallback<T> {
/**
* Handle the specified class name
* Handle the specified class name.
* @param className the class name
* @return a non-null value if processing should end or {@code null} to continue
*/

6
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Repackager.java
View File

@@ -90,7 +90,7 @@ public class Repackager {
}
/**
* Repackage the source file so that it can be run using '{@literal java -jar}'
* 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 if the file cannot be repackaged
*/
@@ -100,7 +100,7 @@ public class Repackager {
/**
* Repackage to the given destination so that it can be launched using '
* {@literal java -jar}'
* {@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 if the file cannot be repackaged
@@ -111,7 +111,7 @@ public class Repackager {
/**
* Repackage to the given destination so that it can be launched using '
* {@literal java -jar}'
* {@literal java -jar}'.
* @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

8
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/RunProcess.java
View File

@@ -155,23 +155,23 @@ public class RunProcess {
}
/**
* @return the running process or {@code null}
* Return the running process.
* @return the process or {@code null}
*/
public Process getRunningProcess() {
return this.process;
}
/**
* @return {@code true} if the process was stopped.
* Return if the process was stopped.
* @return {@code true} if stopped
*/
public boolean handleSigInt() {
// if the process has just ended, probably due to this SIGINT, consider handled.
if (hasJustEnded()) {
return true;
}
return doKill();
}
/**

2
spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/SignalUtils.java
View File

@@ -34,7 +34,7 @@ public final class SignalUtils {
}
/**
* Handle {@literal INT} signals by calling the specified {@link Runnable}
* Handle {@literal INT} signals by calling the specified {@link Runnable}.
* @param runnable the runnable to call on SIGINT.
*/
public static void attachSignalHandler(final Runnable runnable) {

2
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/JavaAgentDetector.java
View File

@@ -19,7 +19,7 @@ package org.springframework.boot.loader;
import java.net.URL;
/**
* A strategy for detecting Java agents
* A strategy for detecting Java agents.
*
* @author Andy Wilkinson
* @since 1.1.0

2
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java
View File

@@ -81,7 +81,7 @@ public abstract class Launcher {
}
/**
* Create a classloader for the specified URLs
* Create a classloader for the specified URLs.
* @param urls the URLs
* @return the classloader
* @throws Exception if the classloader cannot be created

2
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
View File

@@ -112,7 +112,7 @@ public class PropertiesLauncher extends Launcher {
/**
* Properties key for config file location (including optional classpath:, file: or
* URL prefix)
* URL prefix).
*/
public static final String CONFIG_LOCATION = "loader.config.location";

2
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java
View File

@@ -113,7 +113,7 @@ public abstract class Archive {
boolean isDirectory();
/**
* Returns the name of the entry
* Returns the name of the entry.
* @return the name of the entry
*/
AsciiBytes getName();

5
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessDataFile.java
View File

@@ -74,6 +74,7 @@ public class RandomAccessDataFile implements RandomAccessData {
/**
* Private constructor used to create a {@link #getSubsection(long, long) subsection}.
* @param file the underlying file
* @param pool the underlying pool
* @param offset the offset of the section
* @param length the length of the section
@@ -158,7 +159,7 @@ public class RandomAccessDataFile implements RandomAccessData {
* @param len the length of data to read
* @return the number of bytes read into {@code b} or the actual read byte if
* {@code b} is {@code null}. Returns -1 when the end of the stream is reached
* @throws IOException
* @throws IOException in case of I/O errors
*/
public int doRead(byte[] b, int off, int len) throws IOException {
if (len == 0) {
@@ -213,7 +214,7 @@ public class RandomAccessDataFile implements RandomAccessData {
}
/**
* Move the stream position forwards the specified amount
* Move the stream position forwards the specified amount.
* @param amount the amount to move
* @return the amount moved
*/

2
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/CentralDirectoryEndRecord.java
View File

@@ -51,7 +51,7 @@ class CentralDirectoryEndRecord {
* {@link RandomAccessData}, searching backwards from the end until a valid block is
* located.
* @param data the source data
* @throws IOException
* @throws IOException in case of I/O errors
*/
CentralDirectoryEndRecord(RandomAccessData data) throws IOException {
this.block = createBlockFromEndOfData(data, READ_BLOCK_SIZE);

5
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java
View File

@@ -97,9 +97,10 @@ public final class JarEntryData {
}
/**
* @return the underlying {@link RandomAccessData} for this entry. Generally this
* 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)}.
* @return the data
* @throws IOException if the data cannot be read
*/
public RandomAccessData getData() throws IOException {
@@ -200,7 +201,7 @@ public final class JarEntryData {
* @param source the source {@link JarFile}
* @param inputStream the input stream to load data from
* @return a {@link JarEntryData} or {@code null}
* @throws IOException
* @throws IOException in case of I/O errors
*/
static JarEntryData fromInputStream(JarFile source, InputStream inputStream)
throws IOException {

10
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java
View File

@@ -38,17 +38,17 @@ import java.util.Set;
public abstract class SystemPropertyUtils {
/**
* Prefix for system property placeholders: "${"
* Prefix for system property placeholders: "${".
*/
public static final String PLACEHOLDER_PREFIX = "${";
/**
* Suffix for system property placeholders: "}"
* Suffix for system property placeholders: "}".
*/
public static final String PLACEHOLDER_SUFFIX = "}";
/**
* Value separator for system property placeholders: ":"
* Value separator for system property placeholders: ":".
*/
public static final String VALUE_SEPARATOR = ":";
@@ -59,9 +59,9 @@ public abstract class SystemPropertyUtils {
* system property values.
* @param text the String to resolve
* @return the resolved String
* @throws IllegalArgumentException if there is an unresolvable placeholder
* @see #PLACEHOLDER_PREFIX
* @see #PLACEHOLDER_SUFFIX
* @throws IllegalArgumentException if there is an unresolvable placeholder
*/
public static String resolvePlaceholders(String text) {
if (text == null) {
@@ -76,9 +76,9 @@ public abstract class SystemPropertyUtils {
* @param properties a properties instance to use in addition to System
* @param text the String to resolve
* @return the resolved String
* @throws IllegalArgumentException if there is an unresolvable placeholder
* @see #PLACEHOLDER_PREFIX
* @see #PLACEHOLDER_SUFFIX
* @throws IllegalArgumentException if there is an unresolvable placeholder
*/
public static String resolvePlaceholders(Properties properties, String text) {
if (text == null) {

8
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java
View File

@@ -217,8 +217,8 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
/**
* Run with a forked VM, using the specified command line arguments.
* @param args the arguments (JVM arguments and application arguments)
* @throws MojoExecutionException
* @throws MojoFailureException
* @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures
*/
protected abstract void runWithForkedJvm(List<String> args)
throws MojoExecutionException, MojoFailureException;
@@ -227,8 +227,8 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
* Run with the current VM, using the specified arguments.
* @param startClassName the class to run
* @param arguments the class arguments
* @throws MojoExecutionException
* @throws MojoFailureException
* @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures
*/
protected abstract void runWithMavenJvm(String startClassName, String... arguments)
throws MojoExecutionException, MojoFailureException;

2
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ArtifactsLibraries.java
View File

@@ -33,7 +33,7 @@ import org.springframework.boot.loader.tools.LibraryCallback;
import org.springframework.boot.loader.tools.LibraryScope;
/**
* {@link Libraries} backed by Maven {@link Artifact}s
* {@link Libraries} backed by Maven {@link Artifact}s.
*
* @author Phillip Webb
* @author Andy Wilkinson

2
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/FilterableDependency.java
View File

@@ -40,7 +40,7 @@ abstract class FilterableDependency {
private String artifactId;
/**
* The classifier of the artifact to exclude
* The classifier of the artifact to exclude.
*/
@Parameter
private String classifier;

3
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/PropertiesMergingResourceTransformer.java
View File

@@ -41,7 +41,8 @@ public class PropertiesMergingResourceTransformer implements ResourceTransformer
private final Properties data = new Properties();
/**
* @return the data the properties being merged
* Return the data the properties being merged.
* @return the data
*/
public Properties getData() {
return this.data;

15
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/RepackageMojo.java
View File

@@ -235,35 +235,38 @@ public class RepackageMojo extends AbstractDependencyFilterMojo {
return null;
}
/**
* Archive layout types.
*/
public enum LayoutType {
/**
* Jar Layout
* Jar Layout.
*/
JAR(new Layouts.Jar()),
/**
* War Layout
* War Layout.
*/
WAR(new Layouts.War()),
/**
* Zip Layout
* Zip Layout.
*/
ZIP(new Layouts.Expanded()),
/**
* Dir Layout
* Dir Layout.
*/
DIR(new Layouts.Expanded()),
/**
* Module Layout
* Module Layout.
*/
MODULE(new Layouts.Module()),
/**
* No Layout
* No Layout.
*/
NONE(new Layouts.None());

3
spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StartMojo.java
View File

@@ -250,12 +250,13 @@ public class StartMojo extends AbstractRunMojo {
/**
* Execute a task, retrying it on failure.
* @param <T> the result type
* @param wait the wait time
* @param maxAttempts the maximum number of attempts
* @param callback the task to execute (possibly multiple times). The callback should
* return {@code null} to indicate that another attempt should be made
* @return the result
* @throws Exception
* @throws Exception in case of execution errors
*/
public <T> T execute(long wait, int maxAttempts, Callable<T> callback)
throws Exception {