dev.jeka.core.tool.builtins.base

Class JkBaseScaffold

java.lang.Object

dev.jeka.core.api.scaffold.JkScaffold

dev.jeka.core.tool.builtins.base.JkBaseScaffold

public final class JkBaseScaffold
extends JkScaffold

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkBaseScaffold.Kind

Nested classes/interfaces inherited from class dev.jeka.core.api.scaffold.JkScaffold

JkScaffold.JkFileEntry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_CLASS_PATH
BaseKBean.BaseScaffoldOptions	baseScaffoldOption
static java.lang.String	BUILD_CLASS_PATH
static java.util.List<java.lang.String>	deps
static java.util.List<java.lang.String>	devDeps
static java.lang.String	SCRIPT_CLASS_PATH
static java.lang.String	TEST_CLASS_PATH

Fields inherited from class dev.jeka.core.api.scaffold.JkScaffold

baseDir, fileEntries, UNSPECIFIED_JEKA_VERSION

Method Summary

Modifier and Type	Method and Description
JkBaseScaffold	addCustomizer(java.util.function.Consumer<JkBaseScaffold> customizer) Adds a customizer to this instance, that will be executed at run() execution.
static JkBaseScaffold	of(BaseKBean baseKBean) Creates an instance of JkBaseScaffold initialized with the given BaseKBean.
static JkBaseScaffold	of(java.nio.file.Path baseDir, BaseKBean.BaseScaffoldOptions scaffoldOptions) Creates an instance initialized with the base directory and scaffold options..
void	run() Runs the scaffolding, meaning folder structure, build class, props file and .gitignore
JkBaseScaffold	setIncludeJunit(boolean includeJunit) Sets the flag to include Junit dependencies in the scaffold.
static java.lang.String	toJkInject(java.util.List<java.lang.String> deps) Converts a list of dependencies into a string representation of JkDep annotations.

Methods inherited from class dev.jeka.core.api.scaffold.JkScaffold

addFileEntry, addJekaPropsContent, addJekaPropValue, createShellScripts, findLatestStableVersion, getJekaVersion, getJUnitDeps, lastJekaVersion, readResource, removeFileEntriesStartingWith, setJekaDistribLocation, setJekaDistribRepo, setJekaPropsCustomizer, setJekaVersion, setRawJekaPropsPath

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_CLASS_PATH

public static final java.lang.String BUILD_CLASS_PATH

See Also:

Constant Field Values

TEST_CLASS_PATH

public static final java.lang.String TEST_CLASS_PATH

See Also:

Constant Field Values

APP_CLASS_PATH

public static final java.lang.String APP_CLASS_PATH

See Also:

Constant Field Values

SCRIPT_CLASS_PATH

public static final java.lang.String SCRIPT_CLASS_PATH

See Also:

Constant Field Values

devDeps

public static final java.util.List<java.lang.String> devDeps

deps

public static final java.util.List<java.lang.String> deps

baseScaffoldOption

public final BaseKBean.BaseScaffoldOptions baseScaffoldOption

Method Detail

addCustomizer

public JkBaseScaffold addCustomizer(java.util.function.Consumer<JkBaseScaffold> customizer)

Adds a customizer to this instance, that will be executed at run() execution.

of

public static JkBaseScaffold of(java.nio.file.Path baseDir,
                                BaseKBean.BaseScaffoldOptions scaffoldOptions)

Creates an instance initialized with the base directory and scaffold options..

of

public static JkBaseScaffold of(BaseKBean baseKBean)

Creates an instance of JkBaseScaffold initialized with the given BaseKBean.

setIncludeJunit

public JkBaseScaffold setIncludeJunit(boolean includeJunit)

Sets the flag to include Junit dependencies in the scaffold. Initial value is true.

run

public void run()

Description copied from class: JkScaffold

Runs the scaffolding, meaning folder structure, build class, props file and .gitignore

Overrides:

run in class JkScaffold

toJkInject

public static java.lang.String toJkInject(java.util.List<java.lang.String> deps)

Converts a list of dependencies into a string representation of JkDep annotations.

Parameters:

deps - The list of dependencies to convert.

Returns:

The string representation of JkInject annotations.