JkProject

java.lang.Object
- dev.jeka.core.api.project.JkProject

All Implemented Interfaces:: JkBuildable.Supplier, JkIdeSupportSupplier

public final class JkProject
extends java.lang.Object
implements JkIdeSupportSupplier, JkBuildable.Supplier

Stands for the whole project model for building purpose. It has the same purpose and scope than the Maven POM but it also holds methods to actually perform builds.
A complete overview is available here.

A JkProject consists in 4 main parts :

JkProjectCompilation : responsible to generate compile production sources
JkProjectTesting : responsible to compile test sources and run tests
JkProjectPackaging : responsible to creates javadoc, sources and jars
JkMavenPublication : responsible to publish the artifacts on Maven repositories

The pack() method is supposed to generates the artifacts (or simply perform actions as deploying docker image) locally. By default, it generates a regular binary jar, but it can be customized for your needs.

The following represents a tree of the JkProject API.


 project
 +- baseDir
 +- outputDir (generally values to ${baseDir}/jeka-output dir)
 +- artifactLocator (define paths of created artifact files -jar files- )
 |  +- methods: getArtifactPath(), getMainArtifactPath(), ....
 +- duplicateDependencyConflictStrategy
 +- jvmTargetVersion
 +- sourceEncoding
 +- javaCompileToolChain
 +- dependencyResolver
 +- compilation  (produce individual binary files from production sources. This includes resource processing, code generation, processing on .class files, ...)
 |  +- layout (where are located sources, resources and compiled classes)
 |  +- source generators (plugin mechanism for generating source files)
 |  +- dependencies   (stands for compile dependencies)
 |  +- preCompileActions (including resources processing)
 |  +- compileActions (including java sources compilation. Compilation for other languages can be added here)
 |  +- postCompileActions
 |  +- methods : resolveDependencies(), run()
 +- test
 |  +- testCompilation (same as for 'prod' compilation but configured for tests purpose)
 |  +- breakOnFailure (true/false)
 |  +- skipped (true/false)
 |  +- testProcessor
 |  |  +- forkedProcess (configured the forked process who will run tests)
 |  |  +- preActions
 |  |  +- postActions
 |  |  +- engineBehavior
 |  |  |  +- testReportDir
 |  |  |  +- progressDisplayer
 |  |  |  +- launcherConfiguration (based on junit5 platform API)
 |  |  +- testSelection
 |  |  |  +- includePatterns
 |  |  |  +- includeTags
 |  +- method : run()
 +- packaging (produces javadoc and source jar and bin jars)
 |  +- javadocConfiguration
 |  +- runtimeDependencies
 |  +- manifest
 |  +- fatJar (customize produced fat/uber jar if any)
 |  +- methods : createJavadocJar(), createSourceJar(), createBinJar(), createFatJar(), resolveRuntimeDependencies()
 +- e2eTest
 |  +- methods : add(), run()
 +- qualityCheck
 |  +- methods : add(), run()
 + methods :  toDependency(transitivity), getIdeSupport(), pack(), getDependenciesAsXml(), includeLocalAndTextDependencies()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`JkProject.JkProjectE2eTest`
`static class`	`JkProject.JkRunnableContainer`
`static class`	`JkProject.RuntimeDeps` Flag to indicate if we need to include, or not, runtime dependencies in some scenario.

Field Summary

Fields
Modifier and Type	Field and Description
`JkArtifactLocator`	`artifactLocator` Provides conventional path where artifact files are supposed to be generated.
`JkRunnables`	`cleanExtraActions` Defines extra actions to execute when `clean()` is invoked.
`JkProjectCompilation`	`compilation` Object responsible for generating and compiling production sources.
`JkJavaCompilerToolChain`	`compilerToolChain` Defines the tool for compiling both production and test Java sources for this project.
`static java.lang.String`	`CREATE_JAR_ACTION` Deprecated. Use `JkProjectPackaging.CREATE_JAR_ACTION` instead
`static java.lang.String`	`DEPENDENCIES_TXT_FILE`
`JkDependencyResolver`	`dependencyResolver` Object responsible for resolving dependencies.
`JkProject.JkProjectE2eTest`	`e2eTest` Object responsible for running end-to-end tests.
`JkProjectFlatFacade`	`flatFacade` Convenient facade for configuring the project.
`java.util.function.Function<JkIdeSupport,JkIdeSupport>`	`ideSupportModifier` Function to modify the `JkIdeSupport` used for configuring IDEs.
`JkProjectPackaging`	`pack` Object responsible for creating binary, fat, javadoc and sources jars.
`JkRunnables`	`packActions` Deprecated. Use `JkProjectPackaging.actions` instead;
`JkProjectPackaging`	`packaging` Deprecated. Use #pack instead
`static java.lang.String`	`PROJECT_LIBS_DIR`
`JkProject.JkRunnableContainer`	`qualityCheck` Object responsible for running quality checkers.
`JkProjectTesting`	`test` Object responsible for compiling and running tests.
`JkProjectTesting`	`testing` Deprecated. Use #test instead

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JkProject`	`apply(java.util.function.Consumer<JkProject> projectConsumer)` Applies the specified configuration consumer to this project.
`JkBuildable`	`asBuildable()`
`JkProject`	`clean()` Cleans directories where are generated files output by the project builds (jars, generated sources, classes, reports, ...)
`void`	`displayDependencyTree()` Displays the resolved dependency tree on the console.
`java.nio.file.Path`	`getBaseDir()` Returns the base directory from where are resolved all relative path concerning this project (source folder, ...)
`org.w3c.dom.Document`	`getDependenciesAsXml()` Returns an XML document containing the dependency trees of this project.
`JkCoordinate.ConflictStrategy`	`getDuplicateConflictStrategy()` Returns the strategy to use when twi dependencies with distinct versions are declared in the project dependencies.
`java.lang.String`	`getInfo()` Returns a human-readable text that mentions various settings for this project (source locations, file count, declared dependencies, ...).
`JkIdeSupport`	`getJavaIdeSupport()` Returns an ideSupport for this project.
`JkJavaVersion`	`getJvmTargetVersion()` Returns the Java JVM version that will be used to compile sources and generate bytecode.
`JkModuleId`	`getModuleId()` Returns the moduleId of this project.
`java.nio.file.Path`	`getOutputDir()` Returns path of the directory under which are produced build files
`java.lang.String`	`getSourceEncoding()` Returns the source encoding of source files.
`JkVersion`	`getVersion()` Returns the version of the projects.
`boolean`	`isIncludeTextAndLocalDependencies()` Returns if the project dependencies include those mentioned in jeka/project-dependencies.txt flat file.
`static JkProject`	`of()` Creates a new project having the current working directory as base dir.
`void`	`pack()` Deprecated. Use `JkProjectPackaging.run()` instead
`JkJavaProcess`	`prepareRunJar(JkProject.RuntimeDeps runtimeDepInclusion)` Creates `JkJavaProcess` to execute the jar having the specified artifact name.
`JkJavaProcess`	`prepareRunMain()` Creates `JkProcess` to execute the main method for this project.
`JkProject`	`setBaseDir(java.nio.file.Path baseDir)` Sets the base directory for this project.
`JkProject`	`setDuplicateConflictStrategy(JkCoordinate.ConflictStrategy duplicateConflictStrategy)` Sets the strategy to use when twi dependencies with distinct versions are declared in the project dependencies.
`JkProject`	`setIncludeTextAndLocalDependencies(boolean includeTextAndLocalDependencies)` Specifies if the project dependencies should include those mentioned in jeka/project-dependencies.txt flat file.
`JkProject`	`setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker)` Deprecated. Use `JkProjectPackaging.setJarMaker(Consumer)` instead
`JkProject`	`setJvmTargetVersion(JkJavaVersion jvmTargetVersion)` Sets the Java JVM version that will be used to compile sources and generate bytecode.
`JkProject`	`setModuleId(JkModuleId moduleId)` Sets the moduleId for this project.
`JkProject`	`setModuleId(java.lang.String moduleId)`
`JkProject`	`setOutputDir(java.lang.String relativePath)` Sets the output path dir relative to base dir.
`JkProject`	`setSourceEncoding(java.lang.String sourceEncoding)` Sets the source encoding of source files.
`JkProject`	`setVersion(java.lang.String version)` Sets the explicit version of this project.
`JkProject`	`setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier)` Sets the supplier for computing the project version.
`JkLocalProjectDependency`	`toDependency()` Creates a dependency o the regular bin jar created by this project.
`JkLocalProjectDependency`	`toDependency(JkTransitivity transitivity)` Creates a dependency o the regular bin jar of this project, with the specified transitivity.
`JkLocalProjectDependency`	`toDependency(java.lang.Runnable artifactMaker, java.nio.file.Path artifactPath, JkTransitivity transitivity)` Creates a dependency on an artifact created by this project.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATE_JAR_ACTION
```
@Deprecated
public static final java.lang.String CREATE_JAR_ACTION
```
    Deprecated. Use JkProjectPackaging.CREATE_JAR_ACTION instead
    
    See Also:
    
    Constant Field Values
  - DEPENDENCIES_TXT_FILE
```
public static final java.lang.String DEPENDENCIES_TXT_FILE
```
    See Also:
    
    Constant Field Values
  - PROJECT_LIBS_DIR
```
public static final java.lang.String PROJECT_LIBS_DIR
```
    See Also:
    
    Constant Field Values
  - artifactLocator
```
public final JkArtifactLocator artifactLocator
```
    Provides conventional path where artifact files are supposed to be generated.
  - packActions
```
@Deprecated
public final JkRunnables packActions
```
    Deprecated. Use JkProjectPackaging.actions instead;
  - dependencyResolver
```
public final JkDependencyResolver dependencyResolver
```
    Object responsible for resolving dependencies.
  - compilerToolChain
```
public final JkJavaCompilerToolChain compilerToolChain
```
    Defines the tool for compiling both production and test Java sources for this project.
  - compilation
```
public final JkProjectCompilation compilation
```
    Object responsible for generating and compiling production sources.
  - packaging
```
@Deprecated
public final JkProjectPackaging packaging
```
    Deprecated. Use #pack instead
  - pack
```
public final JkProjectPackaging pack
```
    Object responsible for creating binary, fat, javadoc and sources jars. It also defines the runtime dependencies of this project.
  - testing
```
@Deprecated
public final JkProjectTesting testing
```
    Deprecated. Use #test instead
  - test
```
public final JkProjectTesting test
```
    Object responsible for compiling and running tests.
  - e2eTest
```
public final JkProject.JkProjectE2eTest e2eTest
```
    Object responsible for running end-to-end tests. It simply consists in a runnable container where users can register e2e tests and run it a later phase.
  - qualityCheck
```
public final JkProject.JkRunnableContainer qualityCheck
```
    Object responsible for running quality checkers. It simply consists in a runnable container where users can register quality-checkers and run it a later phase.
  - ideSupportModifier
```
public java.util.function.Function<JkIdeSupport,JkIdeSupport> ideSupportModifier
```
    Function to modify the JkIdeSupport used for configuring IDEs.
  - cleanExtraActions
```
public final JkRunnables cleanExtraActions
```
    Defines extra actions to execute when clean() is invoked.
  - flatFacade
```
public final JkProjectFlatFacade flatFacade
```
    Convenient facade for configuring the project.
- Method Detail
  - of
```
public static JkProject of()
```
    Creates a new project having the current working directory as base dir.
  - apply
```
public JkProject apply(java.util.function.Consumer<JkProject> projectConsumer)
```
    Applies the specified configuration consumer to this project.
  - getBaseDir
```
public java.nio.file.Path getBaseDir()
```
    Returns the base directory from where are resolved all relative path concerning this project (source folder, ...)
  - setBaseDir
```
public JkProject setBaseDir(java.nio.file.Path baseDir)
```
    Sets the base directory for this project.
    
    See Also:
    
    getBaseDir()
  - getOutputDir
```
public java.nio.file.Path getOutputDir()
```
    Returns path of the directory under which are produced build files
  - setOutputDir
```
public JkProject setOutputDir(java.lang.String relativePath)
```
    Sets the output path dir relative to base dir.
  - getJvmTargetVersion
```
public JkJavaVersion getJvmTargetVersion()
```
    Returns the Java JVM version that will be used to compile sources and generate bytecode.
  - setJvmTargetVersion
```
public JkProject setJvmTargetVersion(JkJavaVersion jvmTargetVersion)
```
    Sets the Java JVM version that will be used to compile sources and generate bytecode.
  - getSourceEncoding
```
public java.lang.String getSourceEncoding()
```
    Returns the source encoding of source files.
  - setSourceEncoding
```
public JkProject setSourceEncoding(java.lang.String sourceEncoding)
```
    Sets the source encoding of source files.
  - getDuplicateConflictStrategy
```
public JkCoordinate.ConflictStrategy getDuplicateConflictStrategy()
```
    Returns the strategy to use when twi dependencies with distinct versions are declared in the project dependencies.
  - setDuplicateConflictStrategy
```
public JkProject setDuplicateConflictStrategy(JkCoordinate.ConflictStrategy duplicateConflictStrategy)
```
    Sets the strategy to use when twi dependencies with distinct versions are declared in the project dependencies.
  - setJarMaker
```
@Deprecated
public JkProject setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker)
```
    Deprecated. Use JkProjectPackaging.setJarMaker(Consumer) instead
  - prepareRunMain
```
public JkJavaProcess prepareRunMain()
```
    Creates JkProcess to execute the main method for this project.
  - prepareRunJar
```
public JkJavaProcess prepareRunJar(JkProject.RuntimeDeps runtimeDepInclusion)
```
    Creates JkJavaProcess to execute the jar having the specified artifact name. The jar is created on the fly if it is not already present.
    
    Parameters:
    
    runtimeDepInclusion - If INCLUDE, the runtime dependencies will be added to the classpath. This should values EXCLUDE in case of fat jar.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clean
```
public JkProject clean()
```
    Cleans directories where are generated files output by the project builds (jars, generated sources, classes, reports, ...)
  - getInfo
```
public java.lang.String getInfo()
```
    Returns a human-readable text that mentions various settings for this project (source locations, file count, declared dependencies, ...).
  - displayDependencyTree
```
public void displayDependencyTree()
```
    Displays the resolved dependency tree on the console.
  - getJavaIdeSupport
```
public JkIdeSupport getJavaIdeSupport()
```
    Returns an ideSupport for this project.
    
    Specified by:
    
    getJavaIdeSupport in interface JkIdeSupportSupplier
  - toDependency
```
public JkLocalProjectDependency toDependency()
```
    Creates a dependency o the regular bin jar created by this project.
    
    See Also:
    
    toDependency(JkTransitivity)
  - toDependency
```
public JkLocalProjectDependency toDependency(JkTransitivity transitivity)
```
    Creates a dependency o the regular bin jar of this project, with the specified transitivity.
    If the project produces a fat jar, you may prefer to use toDependency(Runnable, Path, JkTransitivity) to have more control on the provided dependency artifact.
    
    See Also:
    
    toDependency(Runnable, Path, JkTransitivity)
  - toDependency
```
public JkLocalProjectDependency toDependency(java.lang.Runnable artifactMaker,
                                             java.nio.file.Path artifactPath,
                                             JkTransitivity transitivity)
```
    Creates a dependency on an artifact created by this project. The created dependency is meant to be consumed by an external project.
  - pack
```
@Deprecated
public void pack()
```
    Deprecated. Use JkProjectPackaging.run() instead
  - isIncludeTextAndLocalDependencies
```
public boolean isIncludeTextAndLocalDependencies()
```
    Returns if the project dependencies include those mentioned in jeka/project-dependencies.txt flat file.
  - setIncludeTextAndLocalDependencies
```
public JkProject setIncludeTextAndLocalDependencies(boolean includeTextAndLocalDependencies)
```
    Specifies if the project dependencies should include those mentioned in jeka/project-dependencies.txt flat file. Values true by default.
  - getDependenciesAsXml
```
public org.w3c.dom.Document getDependenciesAsXml()
```
    Returns an XML document containing the dependency trees of this project. Mainly intended for 3rd party tools.
  - getModuleId
```
public JkModuleId getModuleId()
```
    Returns the moduleId of this project. The moduleId is used to :
    - Publish artifact to Maven/Ivy repository
    - Populate Manifest
    - Reference additional reports
    - Infer produced artifact file name
    - Name Docker images
    - ...
  - setModuleId
```
public JkProject setModuleId(JkModuleId moduleId)
```
    Sets the moduleId for this project.
  - setModuleId
```
public JkProject setModuleId(java.lang.String moduleId)
```
  - getVersion
```
public JkVersion getVersion()
```
    Returns the version of the projects. It returns version explicitly set by setVersion(String) if one has been set. Otherwise, it uses the version returned by the version supplier. The version is used to :
    - Publish artifact to Maven/Ivy repository
    - Populate Manifest
    - Reference additional reports
    - Name Docker images
    - ...
  - setVersionSupplier
```
public JkProject setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier)
```
    Sets the supplier for computing the project version. It can consist in returning an hard-coded version or computing a version number from VCS.
  - setVersion
```
public JkProject setVersion(java.lang.String version)
```
    Sets the explicit version of this project.
  - asBuildable
```
public JkBuildable asBuildable()
```
    Specified by:
    
    asBuildable in interface JkBuildable.Supplier

Class JkProject

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_JAR_ACTION

DEPENDENCIES_TXT_FILE

PROJECT_LIBS_DIR

artifactLocator

packActions

dependencyResolver

compilerToolChain

compilation

packaging

pack

testing

test

e2eTest

qualityCheck

ideSupportModifier

cleanExtraActions

flatFacade

Method Detail

of

apply

getBaseDir

setBaseDir

getOutputDir

setOutputDir

getJvmTargetVersion

setJvmTargetVersion

getSourceEncoding

setSourceEncoding

getDuplicateConflictStrategy

setDuplicateConflictStrategy

setJarMaker

prepareRunMain

prepareRunJar

toString

clean

getInfo

displayDependencyTree

getJavaIdeSupport

toDependency

toDependency

toDependency

pack

isIncludeTextAndLocalDependencies

setIncludeTextAndLocalDependencies

getDependenciesAsXml

getModuleId

setModuleId

setModuleId

getVersion

setVersionSupplier

setVersion

asBuildable