Class ApplicationBuilder

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.java.ApplicationBuilder

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class ApplicationBuilder
extends AbstractGenerator

The ApplicationBuilder generates resources of type ApplicationZipFile or ApplicationTarFile.

Both resource types are runnable application distributions built from a set of classpath resources and a generated start script that launches the application.

The application can be configured using methods that control:

• the output directory for the generated distribution,
• the base name of the generated archive file,
• the executable (start script) name,
• the main class to execute (mandatory),
• and the JVM options required by the application and included in the generated start script.

Method add(Stream) is used to specify the classpath resources to be included in the generated distribution and to be added to the classpath when running the application.

A request for Cleanliness removes any generated distribution archives from the configured destination directory.

The ApplicationBuilder avoids duplicate libraries in the distribution by deduplicating JarFiles based on their file path. If the same jar file is added multiple times, only one copy will be included in the generated distribution.

Constructor Summary

Constructors

Constructor	Description
ApplicationBuilder(Project project)	Initializes a new application builder.

Method Summary

Modifier and Type	Method	Description
ApplicationBuilder	add(Stream<? extends ClasspathElement> resources)	Adds the given classpath resources to the application.
ApplicationBuilder	applicationJvmOpts(Consumer<List<String>> modifier)	Passes the mutable list of JVM options to the given consumer for modification.
Path	destination()	Returns the destination directory.
ApplicationBuilder	destination(Path destination)	Sets the destination directory.
ApplicationBuilder	destination(Supplier<Path> destination)	Sets the destination directory.
String	distributionBaseName()	Returns the base name of the generated TAR or ZIP file.
ApplicationBuilder	distributionBaseName(Supplier<String> distributionBaseName)	Sets the supplier for obtaining the name of the generated ZIP or TAR file's base name in ResourceProviderSpi.provide(ResourceRequest).
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
String	executableName()	Returns the name of the script that starts the application.
ApplicationBuilder	executableName(String name)	Sets the executable name.
String	mainClassName()	Returns the main class name.
ApplicationBuilder	mainClassName(String name)	Sets the name of the main class (the application entry point).
ApplicationBuilder	name(String name)	Set the new name.

Methods inherited from class AbstractGenerator

cleanup, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ResourceProvider

context, name, of, resources

Constructor Details

ApplicationBuilder

public ApplicationBuilder(Project project)

Initializes a new application builder.

Parameters:

project - the project

Method Details

name

public ApplicationBuilder name(String name)

Description copied from interface: Renamable

Set the new name.

Specified by:

name in interface Renamable

Overrides:

name in class AbstractGenerator

Parameters:

name - the name

Returns:

the renamable

executableName

public String executableName()

Returns the name of the script that starts the application. The script for Windows has .bat appended to this name.

Returns:

the string

executableName

public ApplicationBuilder executableName(String name)

Sets the executable name.

Parameters:

name - the name

Returns:

the application builder

destination

public Path destination()

Returns the destination directory. Defaults to sub directory applications in the project's build directory (see Project.buildDirectory()).

Returns:

the destination

destination

public ApplicationBuilder destination(Path destination)

Sets the destination directory. The Path is resolved against the project's build directory (see Project.buildDirectory()).

Parameters:

destination - the new destination

Returns:

the application builder

destination

public ApplicationBuilder destination(Supplier<Path> destination)

Sets the destination directory.

Parameters:

destination - the new destination

Returns:

the jar generator

distributionBaseName

public String distributionBaseName()

Returns the base name of the generated TAR or ZIP file. The base name is the file name without the extension. Defaults to the project's name followed by its version.

Returns:

the string

distributionBaseName

public ApplicationBuilder distributionBaseName(Supplier<String> distributionBaseName)

Sets the supplier for obtaining the name of the generated ZIP or TAR file's base name in ResourceProviderSpi.provide(ResourceRequest).

Parameters:

distributionBaseName - the distribution base name

Returns:

the application builder

mainClassName

public String mainClassName()

Returns the main class name.

Returns:

the main class name

mainClassName

public ApplicationBuilder mainClassName(String name)

Sets the name of the main class (the application entry point).

Parameters:

name - the new main class name

Returns:

the jar generator for method chaining

applicationJvmOpts

public ApplicationBuilder applicationJvmOpts(Consumer<List<String>> modifier)

Passes the mutable list of JVM options to the given consumer for modification. The start script distinguishes between these options, which reflect settings required by the application, and the JAVA_OPTS that may be used when starting the application to tune the JVM for specific environments.

Parameters:

modifier - the modifier

Returns:

the list

add

public ApplicationBuilder add(Stream<? extends ClasspathElement> resources)

Adds the given classpath resources to the application.

Parameters:

resources - the resources

Returns:

the application builder

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

request - the request for resources

Returns:

the stream