rife2/bld-spring-boot
rife2/bld-spring-boot
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Javadocs cleanup

Browse source
This commit is contained in:
Erik C. Thauvin 2023-10-28 12:32:22 -07:00
parent a72995f708
commit e9dede89bf
3 changed files with 28 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/main/java/rife/bld/extension/AbstractBootOperation.java
View file

@ -61,9 +61,9 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Provides the destination file name that will be used for the archive creation. * Provides the file name that will be used for the archive creation.
* *
* @param name the war archive destination file name * @param name the archive file name
* @return this operation instance * @return this operation instance
*/ */
public AbstractBootOperation destinationArchiveFileName(String name) { public AbstractBootOperation destinationArchiveFileName(String name) {
@ -72,9 +72,9 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Retrieves the destination file name that will be used for the JAR creation. * Retrieves the file name that will be used for the archive creation.
* *
* @return the war Jar's destination file name * @return the archive file name
*/ */
public String destinationArchiveFileName() { public String destinationArchiveFileName() {
return destinationArchiveFileName; return destinationArchiveFileName;
@ -83,7 +83,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
/** /**
* Retrieves the destination directory in which the JAR will be created. * Retrieves the destination directory in which the JAR will be created.
* *
* @return the JAR's destination directory * @return the destination directory
*/ */
public File destinationDirectory() { public File destinationDirectory() {
return destinationDirectory_; return destinationDirectory_;
@ -92,7 +92,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
/** /**
* Provides the destination directory in which the archive will be created. * Provides the destination directory in which the archive will be created.
* *
* @param directory the war destination directory * @param directory the destination directory
* @return this operation instance * @return this operation instance
*/ */
public AbstractBootOperation destinationDirectory(File directory) throws IOException { public AbstractBootOperation destinationDirectory(File directory) throws IOException {
@ -102,7 +102,8 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Part of the {@link #execute} operation, copy the {@code spring-boot-loader} archive content to the staging directory. * Part of the {@link #execute} operation, copy the {@code spring-boot-loader} archive content to the staging
* directory.
*/ */
protected void executeCopyBootLoader(File stagingDirectory) throws FileUtilsErrorException { protected void executeCopyBootLoader(File stagingDirectory) throws FileUtilsErrorException {
if (launcherJars_.isEmpty()) { if (launcherJars_.isEmpty()) {
@ -155,7 +156,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
stagingDirectory.exists())); stagingDirectory.exists()));
logger.fine(MessageFormat.format("Destination Directory: {0} (exists:{1})", destinationDirectory(), logger.fine(MessageFormat.format("Destination Directory: {0} (exists:{1})", destinationDirectory(),
destinationDirectory().exists())); destinationDirectory().exists()));
logger.fine(MessageFormat.format("Destination WAR: {0}", destinationArchiveFileName())); logger.fine(MessageFormat.format("Destination Archive: {0}", destinationArchiveFileName()));
} }
var out = new StringWriter(); var out = new StringWriter();
@ -203,7 +204,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Provides library JARs that will be used for the archive creation. * Provides JAR libraries that will be stored in {@code BOOT-INF} or {@code WEB-INF}.
* *
* @param jars Java archive files * @param jars Java archive files
* @return this operation instance * @return this operation instance
@ -214,7 +215,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Provides library JARs that will be used for the archive creation. * Provides JAR libraries that will be stored in {@code BOOT-INF} or {@code WEB-INF}.
* *
* @param jar Java archive file * @param jar Java archive file
* @return this operation instance * @return this operation instance
@ -225,7 +226,7 @@ public abstract class AbstractBootOperation extends AbstractOperation<AbstractBo
} }
/** /**
* Retrieves the library JARs in {@code BOOT-INF} or {@code WEB-INF}. * Retrieves the JAR libraries in {@code BOOT-INF} or {@code WEB-INF}.
*/ */
public List<File> infLibs() { public List<File> infLibs() {
return infLibs_; return infLibs_;

12
src/main/java/rife/bld/extension/BootJarOperation.java
View file

@ -37,9 +37,9 @@ public class BootJarOperation extends AbstractBootOperation {
private static final Logger LOGGER = Logger.getLogger(BootJarOperation.class.getName()); private static final Logger LOGGER = Logger.getLogger(BootJarOperation.class.getName());
/** /**
* Provides the destination file name that will be used for the archive creation. * Provides the destination file name that will be used for the JAR creation.
* *
* @param name the war archive destination file name * @param name the JAR destination file name
* @return this operation instance * @return this operation instance
*/ */
@Override @Override
@ -48,9 +48,9 @@ public class BootJarOperation extends AbstractBootOperation {
} }
/** /**
* Provides the destination directory in which the archive will be created. * Provides the destination directory in which the JAR will be created.
* *
* @param directory the war destination directory * @param directory the JAR destination directory
* @return this operation instance * @return this operation instance
*/ */
@Override @Override
@ -59,7 +59,7 @@ public class BootJarOperation extends AbstractBootOperation {
} }
/** /**
* Provides library JARs that will be used for the JAR creation. * Provides JAR libraries that will be used for the JAR creation.
* *
* @param jars Java archive files * @param jars Java archive files
* @return this operation instance * @return this operation instance
@ -70,7 +70,7 @@ public class BootJarOperation extends AbstractBootOperation {
} }
/** /**
* Provides library JARs that will be used for the JAR creation. * Provides JAR libraries that will be used for the JAR creation.
* *
* @param jar Java archive file * @param jar Java archive file
* @return this operation instance * @return this operation instance

18
src/main/java/rife/bld/extension/BootWarOperation.java
View file

@ -29,7 +29,7 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* Builds and creates a Spring Boot web archive (WAR). * Builds and creates a Spring Boot executable web archive (WAR).
* *
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0 * @since 1.0
@ -39,9 +39,9 @@ public class BootWarOperation extends AbstractBootOperation {
private final List<File> webInfProvidedLibs_ = new ArrayList<>(); private final List<File> webInfProvidedLibs_ = new ArrayList<>();
/** /**
* Provides the destination file name that will be used for the archive creation. * Provides the destination file name that will be used for the WAR creation.
* *
* @param name the war archive destination file name * @param name the wAR archive destination file name
* @return this operation instance * @return this operation instance
*/ */
@Override @Override
@ -50,9 +50,9 @@ public class BootWarOperation extends AbstractBootOperation {
} }
/** /**
* Provides the destination directory in which the archive will be created. * Provides the destination directory in which the WAR will be created.
* *
* @param directory the war destination directory * @param directory the WAR destination directory
* @return this operation instance * @return this operation instance
*/ */
@Override @Override
@ -61,7 +61,7 @@ public class BootWarOperation extends AbstractBootOperation {
} }
/** /**
* Provides library JARs that will be used for the WAR creation. * Provides JAR libraries that will be used for the WAR creation.
* *
* @param jars Java archive files * @param jars Java archive files
* @return this operation instance * @return this operation instance
@ -72,7 +72,7 @@ public class BootWarOperation extends AbstractBootOperation {
} }
/** /**
* Provides library JARs that will be used for the WAR creation. * Provides JAR libraries that will be used for the WAR creation.
* *
* @param jar Java archive file * @param jar Java archive file
* @return this operation instance * @return this operation instance
@ -224,7 +224,7 @@ public class BootWarOperation extends AbstractBootOperation {
/** /**
* Provides library JARs that will be used for the WAR creation in {@code /WEB-INF/lib-provided}. * Provides JAR libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
* *
* @param jars Java archive files * @param jars Java archive files
* @return this operation instance * @return this operation instance
@ -235,7 +235,7 @@ public class BootWarOperation extends AbstractBootOperation {
} }
/** /**
* Provides the library JARs that will be used for the WAR creation in {@code /WEB-INF/lib-provided}. * Provides the JAR libraries that will be used for the WAR creation in {@code /WEB-INF/lib-provided}.
* *
* @param jar Java archive file * @param jar Java archive file
* @return this operation instance * @return this operation instance