Fix javadoc errors and warnings
This commit is contained in:
@@ -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 {
|
||||
|
||||
@@ -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<JarEntry> 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();
|
||||
|
||||
@@ -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;
|
||||
|
||||
|
||||
@@ -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;
|
||||
|
||||
|
||||
@@ -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<String>() {
|
||||
@@ -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 {
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<Archive> archives) throws Exception {
|
||||
}
|
||||
|
||||
@@ -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<Archive> archives) throws Exception {
|
||||
List<URL> urls = new ArrayList<URL>(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<Archive> getClassPathArchives() throws Exception;
|
||||
|
||||
|
||||
@@ -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<Archive> 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;
|
||||
|
||||
@@ -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;
|
||||
|
||||
|
||||
@@ -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) {
|
||||
|
||||
@@ -89,7 +89,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
/**
|
||||
* Create a new {@link JarFile} backed by the specified file.
|
||||
* @param file the root jar file
|
||||
* @throws IOException
|
||||
* @throws IOException if the file cannot be read
|
||||
*/
|
||||
public JarFile(File file) throws IOException {
|
||||
this(new RandomAccessDataFile(file));
|
||||
@@ -98,7 +98,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
/**
|
||||
* Create a new {@link JarFile} backed by the specified file.
|
||||
* @param file the root jar file
|
||||
* @throws IOException
|
||||
* @throws IOException if the file cannot be read
|
||||
*/
|
||||
JarFile(RandomAccessDataFile file) throws IOException {
|
||||
this(file, "", file);
|
||||
@@ -110,7 +110,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
* @param rootFile the root jar file
|
||||
* @param pathFromRoot the name of this file
|
||||
* @param data the underlying data
|
||||
* @throws IOException
|
||||
* @throws IOException if the file cannot be read
|
||||
*/
|
||||
private JarFile(RandomAccessDataFile rootFile, String pathFromRoot,
|
||||
RandomAccessData data) throws IOException {
|
||||
@@ -320,19 +320,19 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
|
||||
/**
|
||||
* Return a nested {@link JarFile} loaded from the specified entry.
|
||||
* @param ze the zip entry
|
||||
* @param entry the zip entry
|
||||
* @return a {@link JarFile} for the entry
|
||||
* @throws IOException
|
||||
* @throws IOException if the nested jar file cannot be read
|
||||
*/
|
||||
public synchronized JarFile getNestedJarFile(final ZipEntry ze) throws IOException {
|
||||
return getNestedJarFile(getContainedEntry(ze).getSource());
|
||||
public synchronized JarFile getNestedJarFile(final ZipEntry entry) throws IOException {
|
||||
return getNestedJarFile(getContainedEntry(entry).getSource());
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a nested {@link JarFile} loaded from the specified entry.
|
||||
* @param sourceEntry the zip entry
|
||||
* @return a {@link JarFile} for the entry
|
||||
* @throws IOException
|
||||
* @throws IOException if the nested jar file cannot be read
|
||||
*/
|
||||
public synchronized JarFile getNestedJarFile(JarEntryData sourceEntry)
|
||||
throws IOException {
|
||||
@@ -388,7 +388,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
* Return a new jar based on the filtered contents of this file.
|
||||
* @param filters the set of jar entry filters to be applied
|
||||
* @return a filtered {@link JarFile}
|
||||
* @throws IOException
|
||||
* @throws IOException if the jar file cannot be read
|
||||
*/
|
||||
public synchronized JarFile getFilteredJarFile(JarEntryFilter... filters)
|
||||
throws IOException {
|
||||
@@ -418,7 +418,7 @@ public class JarFile extends java.util.jar.JarFile implements Iterable<JarEntryD
|
||||
* Return a URL that can be used to access this JAR file. NOTE: the specified URL
|
||||
* cannot be serialized and or cloned.
|
||||
* @return the URL
|
||||
* @throws MalformedURLException
|
||||
* @throws MalformedURLException if the URL is malformed
|
||||
*/
|
||||
public URL getUrl() throws MalformedURLException {
|
||||
if (this.url == null) {
|
||||
|
||||
@@ -42,7 +42,7 @@ public final class AsciiBytes {
|
||||
|
||||
/**
|
||||
* Create a new {@link AsciiBytes} from the specified String.
|
||||
* @param string
|
||||
* @param string the source string
|
||||
*/
|
||||
public AsciiBytes(String string) {
|
||||
this(string.getBytes(UTF_8));
|
||||
@@ -52,7 +52,7 @@ public final class AsciiBytes {
|
||||
/**
|
||||
* Create a new {@link AsciiBytes} from the specified bytes. NOTE: underlying bytes
|
||||
* are not expected to change.
|
||||
* @param bytes the bytes
|
||||
* @param bytes the source bytes
|
||||
*/
|
||||
public AsciiBytes(byte[] bytes) {
|
||||
this(bytes, 0, bytes.length);
|
||||
@@ -61,7 +61,7 @@ public final class AsciiBytes {
|
||||
/**
|
||||
* Create a new {@link AsciiBytes} from the specified bytes. NOTE: underlying bytes
|
||||
* are not expected to change.
|
||||
* @param bytes the bytes
|
||||
* @param bytes the source bytes
|
||||
* @param offset the offset
|
||||
* @param length the length
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user