dev.jeka.core.tool

Class KBean

java.lang.Object

dev.jeka.core.tool.KBean

Direct Known Subclasses:

AppKBean, BaseKBean, DockerKBean, EclipseKBean, GitKBean, IntellijKBean, MavenKBean, NativeKBean, ProjectKBean, SetupKBean

public abstract class KBean
extends java.lang.Object

Base class for KBean. User code is not supposed to instantiate KBeans using 'new' but usinng JkRunbase.load(java.lang.Class).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KBean() Use init() instead!

Method Summary

Modifier and Type	Method and Description
KBean	cleanOutput() Cleans output directory.
<T extends KBean> java.util.Optional<T>	find(java.lang.Class<T> beanClass)
java.nio.file.Path	getBaseDir() Returns the base directory of the project.
java.lang.String	getBaseDirName() Returns the name of the folder which stands for the project base directory.
java.nio.file.Path	getBasePath(java.lang.String relativePath) Resolves the given relative path against the base directory of the project.
java.nio.file.Path	getOutputDir() Returns the output directory where all the final and intermediate artifacts are generated.
JkRunbase	getRunbase() Returns the JkRunbase where this KBean has been instantiated.
protected void	init() This method is called by JeKa engine, right after public fields from command-line or properties have been injected.
<T extends KBean> T	load(java.lang.Class<T> beanClass)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KBean

protected KBean()

Use init() instead!

Code added here won't work as expected since public fields (such as those from command-line properties, basedir, and imported KBeans) are not yet initialized.

Method Detail

init

protected void init()

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.

getBaseDir

public final java.nio.file.Path getBaseDir()

Returns the base directory of the project. In single projects, base dir = working dir. When working in multi-project (aka multi-module project), the base dir will be the sub-project base directory.

getBasePath

public final java.nio.file.Path getBasePath(java.lang.String relativePath)

Resolves the given relative path against the base directory of the project.

getBaseDirName

public final java.lang.String getBaseDirName()

Returns the name of the folder which stands for the project base directory.

getOutputDir

public final java.nio.file.Path getOutputDir()

Returns the output directory where all the final and intermediate artifacts are generated.

getRunbase

public final JkRunbase getRunbase()

Returns the JkRunbase where this KBean has been instantiated.

load

public final <T extends KBean> T load(java.lang.Class<T> beanClass)

See Also:

JkRunbase.load(Class)

find

public final <T extends KBean> java.util.Optional<T> find(java.lang.Class<T> beanClass)

See Also:

JkRunbase.find(Class)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

cleanOutput

public KBean cleanOutput()

Cleans output directory.