dev.jeka.core.api.project

Class JkProjectPackaging

java.lang.Object

dev.jeka.core.api.project.JkProjectPackaging

public class JkProjectPackaging
extends java.lang.Object

Responsible to create binary, Javadoc and Source jars.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkProjectPackaging.JarType

Field Summary

Fields

Modifier and Type	Field and Description
JkRunnables	actions Actions to execute when JkProject.pack() is invoked.
static java.lang.String	CREATE_JAR_ACTION Represents the identifier for an action to create a JAR file in the project lifecycle.
JkJavadocProcessor	javadocProcessor Provides fluent interface for producing Javadoc.
JkConsumers<JkManifest>	manifestCustomizer Consumer container for customizing the manifest that will bbe included in constructed Jar files.
JkDependencySetModifier	runtimeDependencies

Method Summary

Modifier and Type	Method and Description
void	copyManifestInClassDir() Copies the manifest file to the class directory.
java.nio.file.Path	createBinJar() Creates a binary jar at conventional location.
void	createBinJar(java.nio.file.Path target) Creates a binary jar (without dependencies) at the specified location.
java.nio.file.Path	createFatJar() Creates a fat jar at conventional location.
void	createFatJar(java.nio.file.Path target) Creates a fat jar (jar containing all dependencies) at the specified location.
java.nio.file.Path	createJavadocJar() Creates a Javadoc jar at conventional location.
void	createJavadocJar(java.nio.file.Path target) Creates a Javadoc jar at the specified location.
void	createShadeJar(java.nio.file.Path target) Same as createFatJar but relocate packages of the dependency jars in order to not collide with dependencies in classpath.
java.nio.file.Path	createSourceJar() Creates a source jar at the specified location.
void	createSourceJar(java.nio.file.Path target) Creates a source jar at specified location.
JkProjectPackaging	customizeFatJarContent(java.util.function.Function<JkPathTreeSet,JkPathTreeSet> customizer) Allows customizing thz content of produced fat jar.
java.nio.file.Path	getJavadocDir()
java.lang.String	getMainClass() Returns the main class name of the project.
JkManifest	getManifest()
java.lang.String	getOrFindMainClass() Retrieves the main class name of the project.
boolean	isDetectMainClass()
JkResolveResult	resolveRuntimeDependencies() Returns the resolved (and cached) dependencies needed at runtime.
java.util.List<java.nio.file.Path>	resolveRuntimeDependenciesAsFiles() Retrieves the runtime dependencies as a sequence of files.
void	run() Executes the packing process for this project, which includes compiling, testing, and creating JAR files.
JkProjectPackaging	setDetectMainClass(boolean detectMainClass) Sets whether to detect the main class when running or building the project.
JkProjectPackaging	setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker) Sets a Runnable to create the JAR used by JkProject.prepareRunJar(JkProject.RuntimeDeps)
JkProjectPackaging	setMainClass(java.lang.String mainClass) Sets the main class name to use in #runXxx and for building docker images.
JkProjectPackaging	setMainClassFinder(java.util.function.Supplier<java.lang.String> mainClassFinder) Sets the main class finder for this project.

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_JAR_ACTION

public static final java.lang.String CREATE_JAR_ACTION

Represents the identifier for an action to create a JAR file in the project lifecycle. Used within the context of project execution to trigger the corresponding task or operation that handles the creation of the Java Archive (JAR) artifact.

See Also:

Constant Field Values

actions

public final JkRunnables actions

Actions to execute when JkProject.pack() is invoked.

By default, the build action creates a regular binary jar. It can be replaced by an action creating other jars/artifacts or doing special action as publishing a Docker image, for example.

To insert before the JAR action, use JkRunnables.insertBefore(String, String, Runnable) by specifying the CREATE_JAR_ACTION as action to insert before.

manifestCustomizer

public final JkConsumers<JkManifest> manifestCustomizer

Consumer container for customizing the manifest that will bbe included in constructed Jar files.

javadocProcessor

public final JkJavadocProcessor javadocProcessor

Provides fluent interface for producing Javadoc.

runtimeDependencies

public final JkDependencySetModifier runtimeDependencies

Method Detail

run

public void run()

Executes the packing process for this project, which includes compiling, testing, and creating JAR files.

See Also:

actions

setJarMaker

public JkProjectPackaging setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker)

Sets a Runnable to create the JAR used by JkProject.prepareRunJar(JkProject.RuntimeDeps)

getJavadocDir

public java.nio.file.Path getJavadocDir()

getManifest

public JkManifest getManifest()

createJavadocJar

public void createJavadocJar(java.nio.file.Path target)

Creates a Javadoc jar at the specified location.

createJavadocJar

public java.nio.file.Path createJavadocJar()

Creates a Javadoc jar at conventional location.

createSourceJar

public void createSourceJar(java.nio.file.Path target)

Creates a source jar at specified location.

createSourceJar

public java.nio.file.Path createSourceJar()

Creates a source jar at the specified location.

createBinJar

public void createBinJar(java.nio.file.Path target)

Creates a binary jar (without dependencies) at the specified location.

createBinJar

public java.nio.file.Path createBinJar()

Creates a binary jar at conventional location.

createFatJar

public void createFatJar(java.nio.file.Path target)

Creates a fat jar (jar containing all dependencies) at the specified location.

createShadeJar

public void createShadeJar(java.nio.file.Path target)

Same as createFatJar but relocate packages of the dependency jars in order to not collide with dependencies in classpath.

createFatJar

public java.nio.file.Path createFatJar()

Creates a fat jar at conventional location.

setDetectMainClass

public JkProjectPackaging setDetectMainClass(boolean detectMainClass)

Sets whether to detect the main class when running or building the project.

isDetectMainClass

public boolean isDetectMainClass()

setMainClass

public JkProjectPackaging setMainClass(java.lang.String mainClass)

Sets the main class name to use in #runXxx and for building docker images.

setMainClassFinder

public JkProjectPackaging setMainClassFinder(java.util.function.Supplier<java.lang.String> mainClassFinder)

Sets the main class finder for this project. The main class finder is responsible for providing the name of the main class to use in the project. This can be used for running the project or building Docker images.

getMainClass

public java.lang.String getMainClass()

Returns the main class name of the project. This might be null for library projects.

getOrFindMainClass

public java.lang.String getOrFindMainClass()

Retrieves the main class name of the project. If the main class name is not provided, it will try to discover it.

customizeFatJarContent

public JkProjectPackaging customizeFatJarContent(java.util.function.Function<JkPathTreeSet,JkPathTreeSet> customizer)

Allows customizing thz content of produced fat jar.

resolveRuntimeDependencies

public JkResolveResult resolveRuntimeDependencies()

Returns the resolved (and cached) dependencies needed at runtime.

resolveRuntimeDependenciesAsFiles

public java.util.List<java.nio.file.Path> resolveRuntimeDependenciesAsFiles()

Retrieves the runtime dependencies as a sequence of files.

copyManifestInClassDir

public void copyManifestInClassDir()

Copies the manifest file to the class directory.