BaseKBean

java.lang.Object
- dev.jeka.core.tool.KBean
- - dev.jeka.core.tool.builtins.base.BaseKBean

All Implemented Interfaces:: JkBuildable.Supplier

public final class BaseKBean
extends KBean
implements JkBuildable.Supplier

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseKBean.BaseScaffoldOptions

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseKBean.BaseScaffoldOptions`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CREATE_JAR_ACTION`
`JkGitVersioning`	`gitVersioning`
`JkProjectPackaging.JarType`	`jarType`
`java.lang.String`	`jvmOptions`
`JkConsumers<JkManifest>`	`manifestCustomizers`
`java.lang.String`	`moduleId`
`JkRunnables`	`packActions` Actions to execute when `pack()` is invoked.
`java.lang.String`	`programArgs`

Constructor Summary

Constructors
Constructor and Description

BaseKBean()

Constructors
Constructor and Description
`BaseKBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JkBuildable`	`asBuildable()`
`BaseKBean`	`buildJar()` Builds a JAR file using the provided jarMaker
`void`	`createJavadocJar(java.nio.file.Path target)` Creates a Javadoc Jar file at the specified target path.
`void`	`createMainJar(java.nio.file.Path target)` Creates a main JAR file at the specified target path.
`void`	`createSourceJar(java.nio.file.Path target)` Creates a source JAR file at the specified target path.
`void`	`depTree()`
`JkPathTree`	`getAppClasses()` Returns a `JkPathTree` representing the class files and sub-folders contained in the "bin" directory.
`java.util.List<java.nio.file.Path>`	`getAppClasspath()` Returns the application classpath.
`java.util.List<java.nio.file.Path>`	`getAppLibs()` Returns a List of Path objects representing the libraries used by the application.
`JkPathTree`	`getAppSources()` Returns a JkPathTree representing the application sources.
`JkBaseScaffold`	`getBaseScaffold()` Returns the JkBaseScaffold object associated with this BaseKBean.
`java.nio.file.Path`	`getJarPath()` Returns the path to the JAR file created by `buildJar()` method.
`java.lang.String`	`getJarPathBaseName()` Returns the base name of the JAR file path created by the `buildJar()` method.
`java.lang.String`	`getMainClass()` Returns the actual main class to be used for launching the application or executable JAR.
`JkManifest`	`getManifest()` Returns the `JkManifest` for the application.
`JkModuleId`	`getModuleId()` Returns the module ID for this object.
`JkVersion`	`getVersion()` Returns the version of the application/library.
`void`	`info()`
`protected void`	`init()` This method is called by JeKa engine, right after public fields from command-line or properties have been injected.
`void`	`pack()`
`JkJavaProcess`	`prepareRunJar()` Prepares a {@link JkJavaProcess ready to run.
`void`	`runJar()`
`void`	`runMain()`
`void`	`scaffold()`
`BaseKBean`	`setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker)` Sets the jarMaker for creating a runnable fat jar.
`BaseKBean`	`setMainArtifactJarType(JkProjectPackaging.JarType jarType)`
`BaseKBean`	`setMainClassFinder(java.util.function.Supplier<java.lang.String> mainClassFinder)` Sets the main class finder for this project.
`BaseKBean`	`setModuleId(java.lang.String moduleId)` Sets the module ID for this object.
`BaseKBean`	`setVersion(java.lang.String version)` Sets the version for this BaseKBean.
`BaseKBean`	`setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier)` Sets the version supplier for this BaseKBean.
`void`	`test()`

Methods inherited from class dev.jeka.core.tool.KBean
cleanOutput, find, getBaseDir, getBaseDirName, getBasePath, getImportedKBeans, getOutputDir, getRunbase, load, toString

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

- Field Detail
  - CREATE_JAR_ACTION
```
public static final java.lang.String CREATE_JAR_ACTION
```
    See Also:
    
    Constant Field Values
  - jvmOptions
```
public java.lang.String jvmOptions
```
  - programArgs
```
public java.lang.String programArgs
```
  - moduleId
```
public java.lang.String moduleId
```
  - jarType
```
public JkProjectPackaging.JarType jarType
```
  - gitVersioning
```
public JkGitVersioning gitVersioning
```
  - packActions
```
public final JkRunnables packActions
```
    Actions to execute when pack() is invoked.
    By default, the build action creates a fat jar. It can be replaced by an action creating other jars/artifacts or doing special action as publishing a Docker image, for example.
  - manifestCustomizers
```
public final JkConsumers<JkManifest> manifestCustomizers
```
- Constructor Detail
  - BaseKBean
```
public BaseKBean()
```
- Method Detail
  - init
```
protected void init()
```
    Description copied from class: KBean
    
    This method is called by JeKa engine, right after public fields from command-line or properties have been injected.
    Put your initialization/configuration code here.
    
    Overrides:
    
    init in class KBean
  - runMain
```
public void runMain()
```
  - test
```
public void test()
```
  - pack
```
public void pack()
```
  - runJar
```
public void runJar()
```
  - info
```
public void info()
```
  - depTree
```
public void depTree()
```
  - scaffold
```
public void scaffold()
```
  - buildJar
```
public BaseKBean buildJar()
```
    Builds a JAR file using the provided jarMaker
  - getJarPath
```
public java.nio.file.Path getJarPath()
```
    Returns the path to the JAR file created by buildJar() method.
  - getJarPathBaseName
```
public java.lang.String getJarPathBaseName()
```
    Returns the base name of the JAR file path created by the buildJar() method.
  - setJarMaker
```
public BaseKBean setJarMaker(java.util.function.Consumer<java.nio.file.Path> jarMaker)
```
    Sets the jarMaker for creating a runnable fat jar.
  - setVersionSupplier
```
public BaseKBean setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier)
```
    Sets the version supplier for this BaseKBean. The version represents the version of the application/library.
  - setVersion
```
public BaseKBean setVersion(java.lang.String version)
```
    Sets the version for this BaseKBean. The version represents the version of the application/library.
  - getVersion
```
public JkVersion getVersion()
```
    Returns the version of the application/library. The version might be used in Manifest file, docker image name or Maven publication.
  - getModuleId
```
public JkModuleId getModuleId()
```
    Returns the module ID for this object. The module ID is used for naming Docker image and in Maven publication.
  - setModuleId
```
public BaseKBean setModuleId(java.lang.String moduleId)
```
    Sets the module ID for this object. The module id might be used for naming Docker image and in Maven publication.
    
    Parameters:
    
    moduleId - The module ID formatted as group:name.
  - getMainClass
```
public java.lang.String getMainClass()
```
    Returns the actual main class to be used for launching the application or executable JAR. This method returns null if no main class has been detected.
  - getBaseScaffold
```
public JkBaseScaffold getBaseScaffold()
```
    Returns the JkBaseScaffold object associated with this BaseKBean. The JkBaseScaffold provides methods for configuring the project scaffold, such as adding file entries and setting options.
  - setMainClassFinder
```
public BaseKBean 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.
  - getAppClasspath
```
public java.util.List<java.nio.file.Path> getAppClasspath()
```
    Returns the application classpath. This contains class dir + libraries.
  - getAppLibs
```
public java.util.List<java.nio.file.Path> getAppLibs()
```
    Returns a List of Path objects representing the libraries used by the application. It contains the classpath minus the class dir.
  - getAppClasses
```
public JkPathTree getAppClasses()
```
    Returns a JkPathTree representing the class files and sub-folders contained in the "bin" directory. The tree includes all files in the root directory and its subdirectories, except for files matching the specified patterns.
  - getManifest
```
public JkManifest getManifest()
```
    Returns the JkManifest for the application. The manifest includes the created by attribute, the main class attribute, and the build JDK attribute.
  - createMainJar
```
public void createMainJar(java.nio.file.Path target)
```
    Creates a main JAR file at the specified target path.
  - createJavadocJar
```
public void createJavadocJar(java.nio.file.Path target)
```
    Creates a Javadoc Jar file at the specified target path.
  - createSourceJar
```
public void createSourceJar(java.nio.file.Path target)
```
    Creates a source JAR file at the specified target path.
  - getAppSources
```
public JkPathTree getAppSources()
```
    Returns a JkPathTree representing the application sources.
  - prepareRunJar
```
public JkJavaProcess prepareRunJar()
```
    Prepares a {@link JkJavaProcess ready to run.
  - setMainArtifactJarType
```
public BaseKBean setMainArtifactJarType(JkProjectPackaging.JarType jarType)
```
  - asBuildable
```
public JkBuildable asBuildable()
```
    Specified by:
    
    asBuildable in interface JkBuildable.Supplier

Class BaseKBean

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dev.jeka.core.tool.KBean

Methods inherited from class java.lang.Object

Field Detail

CREATE_JAR_ACTION

jvmOptions

programArgs

moduleId

jarType

gitVersioning

packActions

manifestCustomizers

Constructor Detail

BaseKBean

Method Detail

init

runMain

test

pack

runJar

info

depTree

scaffold

buildJar

getJarPath

getJarPathBaseName

setJarMaker

setVersionSupplier

setVersion

getVersion

getModuleId

setModuleId

getMainClass

getBaseScaffold

setMainClassFinder

getAppClasspath

getAppLibs

getAppClasses

getManifest

createMainJar

createJavadocJar

createSourceJar

getAppSources

prepareRunJar

setMainArtifactJarType

asBuildable