dev.jeka.core.api.project

Class JkProjectFlatFacade

java.lang.Object

dev.jeka.core.api.project.JkProjectFlatFacade

public class JkProjectFlatFacade
extends java.lang.Object

A simplified facade over JkProject to access its configuration through a single entry point. This class organizes its methods into the following categories for easier exploration, following a consistent naming convention:

• Configuration Methods: setXXX(), addXXX(), removeXXX()
  These methods modify the underlying project configuration.
• Action Methods: doXXX()
  These methods trigger specific actions, such as building the project.
• Getter Methods: getXXX()
  These methods retrieve information from the project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JkProjectFlatFacade.JkDependencyFacade

Field Summary

Fields

Modifier and Type	Field and Description
JkProjectFlatFacade.JkDependencyFacade	dependencies

Method Summary

Modifier and Type	Method and Description
JkProjectFlatFacade	addCompileOnlyDeps(java.lang.String coordinate) Adds compile-only dependencies to the project.
JkProjectFlatFacade	addShadeJarArtifact(java.lang.String classifier)
JkProjectFlatFacade	addSourceGenerator(JkProjectSourceGenerator sourceGenerator) Adds a source generator to the project.
JkProjectFlatFacade	addTestExcludeSuffixIf(boolean condition, java.lang.String suffix) By default, every class in test folder are run.
JkProjectFlatFacade	addTestIncludeSuffixIf(boolean condition, java.lang.String suffix) By default, every class in test folder are run.
JkProjectFlatFacade	addTestMavenIncludePattern(boolean condition) Adds a test include filters for test classes named as ^(Test.*|.+[.$]Test.*|.*Tests?)$.
JkProjectFlatFacade	doFastPack() Same as doPack() but skips the testing phase.
JkProjectFlatFacade	doPack() Executes the packing process for this project, which includes compiling, testing, and creating JAR files.
java.nio.file.Path	getClassDir() Returns the directory where compiled classes are stored.
java.nio.file.Path	getMainJar() Returns the main JAR file produced by the build.
JkProject	getProject() Returns the project associated with this facade.
java.util.List<java.nio.file.Path>	getRuntimeClasspath() Returns the classpath used for running the built jar.
JkProjectFlatFacade	removeAllTestIncludePatterns() Removes all test include patterns, effectively clearing any previously set test class inclusion filters.
JkProjectFlatFacade	setBaseDir(java.nio.file.Path baseDir) Sets the base directory for this Project.
JkProjectFlatFacade	setBaseDir(java.lang.String baseDir) Sets the base directory for this Project by specifying a String representing the base directory path.
JkProjectFlatFacade	setJvmTargetVersion(JkJavaVersion version) Sets the Java JVM version that will be used to compile sources and generate bytecode.
JkProjectFlatFacade	setLayoutStyle(JkCompileLayout.Style style) Sets the layout style for the project's compilation layout.
JkProjectFlatFacade	setMainArtifactJarType(JkProjectPackaging.JarType jarType) Sets if the project should produce regular or fat jar by default.
JkProjectFlatFacade	setMainClass(java.lang.String mainClass) Sets the main class name to use in #runXxx and for building docker images.
JkProjectFlatFacade	setMixResourcesAndSources() The resources will be located in same the dir than the sources.
JkProjectFlatFacade	setModuleId(java.lang.String moduleId)
JkProjectFlatFacade	setSourceEncoding(java.lang.String encoding) Sets the source encoding for the project.
JkProjectFlatFacade	setTestProgressStyle(JkTestProcessor.JkProgressStyle style) Sets the style for displaying test progress during test execution.
JkProjectFlatFacade	setTestsSkipped(boolean skipped) Sets whether to skip running tests for the project.
JkProjectFlatFacade	setVersion(java.lang.String version) Sets the version of the project.
JkProjectFlatFacade	setVersionFromGitTag() The published version will be computed according the current git tag.
JkProjectFlatFacade	setVersionFromGitTagCommitMessage(java.lang.String suffixKeyword) The published version will be computed according the last Git commit message.
JkProjectFlatFacade	setVersionSupplier(java.util.function.Supplier<java.lang.String> versionSupplier) Sets the supplier for computing the project version.

Methods inherited from class java.lang.Object

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

Field Detail

dependencies

public final JkProjectFlatFacade.JkDependencyFacade dependencies

Method Detail

setJvmTargetVersion

public JkProjectFlatFacade setJvmTargetVersion(JkJavaVersion version)

Sets the Java JVM version that will be used to compile sources and generate bytecode.

setMainArtifactJarType

public JkProjectFlatFacade setMainArtifactJarType(JkProjectPackaging.JarType jarType)

Sets if the project should produce regular or fat jar by default.

addShadeJarArtifact

public JkProjectFlatFacade addShadeJarArtifact(java.lang.String classifier)

setSourceEncoding

public JkProjectFlatFacade setSourceEncoding(java.lang.String encoding)

Sets the source encoding for the project.

setBaseDir

public JkProjectFlatFacade setBaseDir(java.nio.file.Path baseDir)

Sets the base directory for this Project.

setBaseDir

public JkProjectFlatFacade setBaseDir(java.lang.String baseDir)

Sets the base directory for this Project by specifying a String representing the base directory path.

setLayoutStyle

public JkProjectFlatFacade setLayoutStyle(JkCompileLayout.Style style)

Sets the layout style for the project's compilation layout.

setMixResourcesAndSources

public JkProjectFlatFacade setMixResourcesAndSources()

The resources will be located in same the dir than the sources.

setMainClass

public JkProjectFlatFacade setMainClass(java.lang.String mainClass)

Sets the main class name to use in #runXxx and for building docker images. The value "auto" means that it will e auto-discovered.

See Also:

JkProjectPackaging.setMainClass(String)

addCompileOnlyDeps

public JkProjectFlatFacade addCompileOnlyDeps(java.lang.String coordinate)

Adds compile-only dependencies to the project.

Parameters:

coordinate - the dependency to be added in the format of group:artifactId:version

setTestsSkipped

public JkProjectFlatFacade setTestsSkipped(boolean skipped)

Sets whether to skip running tests for the project.

setVersionSupplier

public JkProjectFlatFacade setVersionSupplier(java.util.function.Supplier<java.lang.String> versionSupplier)

Sets the supplier for computing the project version.

Parameters:

versionSupplier - the supplier for computing the project version.

setVersion

public JkProjectFlatFacade setVersion(java.lang.String version)

Sets the version of the project.

Parameters:

version - the version to set for the project.

setVersionFromGitTag

public JkProjectFlatFacade setVersionFromGitTag()

The published version will be computed according the current git tag.

See Also:

JkGit.getVersionFromTag()

setVersionFromGitTagCommitMessage

public JkProjectFlatFacade setVersionFromGitTagCommitMessage(java.lang.String suffixKeyword)

The published version will be computed according the last Git commit message.

See Also:

JkGit.getVersionFromCommitMessage(String)

setModuleId

public JkProjectFlatFacade setModuleId(java.lang.String moduleId)

Parameters:

moduleId - group + artifactId to use when publishing on a binary repository. Must be formatted as 'group:artifactId'

addTestExcludeSuffixIf

public JkProjectFlatFacade addTestExcludeSuffixIf(boolean condition,
                                                  java.lang.String suffix)

By default, every class in test folder are run. If you add an exclude filter, tests accepting this filter won't be run.

Parameters:

condition - : the filter will be added only if this parameter is true.

addTestIncludeSuffixIf

public JkProjectFlatFacade addTestIncludeSuffixIf(boolean condition,
                                                  java.lang.String suffix)

By default, every class in test folder are run. If you add an including filter, only tests accepting one of the declared filters will run.

Parameters:

condition - : the filter will be added only if this parameter is true.

addTestMavenIncludePattern

public JkProjectFlatFacade addTestMavenIncludePattern(boolean condition)

Adds a test include filters for test classes named as ^(Test.*|.+[.$]Test.*|.*Tests?)$. This is a standard filter in many tools.

See Also:

addTestIncludeSuffixIf(boolean, String)

removeAllTestIncludePatterns

public JkProjectFlatFacade removeAllTestIncludePatterns()

Removes all test include patterns, effectively clearing any previously set test class inclusion filters. This ensures that all class tests are included.

setTestProgressStyle

public JkProjectFlatFacade setTestProgressStyle(JkTestProcessor.JkProgressStyle style)

Sets the style for displaying test progress during test execution.

addSourceGenerator

public JkProjectFlatFacade addSourceGenerator(JkProjectSourceGenerator sourceGenerator)

Adds a source generator to the project.

doPack

public JkProjectFlatFacade doPack()

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

See Also:

JkProject.packActions

doFastPack

public JkProjectFlatFacade doFastPack()

Same as doPack() but skips the testing phase.

getProject

public JkProject getProject()

Returns the project associated with this facade.

getMainJar

public java.nio.file.Path getMainJar()

Returns the main JAR file produced by the build.

getClassDir

public java.nio.file.Path getClassDir()

Returns the directory where compiled classes are stored.

getRuntimeClasspath

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

Returns the classpath used for running the built jar.