dev.jeka.core.api.project.scaffold

Class JkProjectScaffold

java.lang.Object

dev.jeka.core.api.scaffold.JkScaffold

dev.jeka.core.api.project.scaffold.JkProjectScaffold

public final class JkProjectScaffold
extends JkScaffold

Provides features to scaffold projects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkProjectScaffold.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	BUILD_CLASS_PATH
java.util.List<java.lang.String>	compileDeps
protected JkProject	project
java.util.List<java.lang.String>	runtimeDeps
static java.lang.String	SIMPLE_STYLE_PROP
java.util.List<java.lang.String>	testDeps

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

baseDir, fileEntries, UNSPECIFIED_JEKA_VERSION

Method Summary

Modifier and Type	Method and Description
JkProjectScaffold	addCustomizer(java.util.function.Consumer<JkProjectScaffold> customizer) Registers for customizers that will be applied at #run execution.
java.lang.String	getResRelPath()
java.lang.String	getSrcRelPath()
JkProjectScaffold.Kind	getTemplate() Returns the template currently set for this scaffold
java.lang.String	getTestRelPath()
java.lang.String	getTestResPath()
static JkProjectScaffold	of(JkProject project)
void	removeFileEntry(java.lang.String relativePath) Removes a file entry from the list of file entries.
void	run() Runs the scaffolding, meaning folder structure, build class, props file and .gitignore
JkProjectScaffold	setGenerateLibsFolders(boolean generateLibsFolders)
JkProjectScaffold	setKind(JkProjectScaffold.Kind kind) Sets the template for this scaffold.
JkProjectScaffold	setUseSimpleStyle(boolean useSimpleStyle)

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

SIMPLE_STYLE_PROP

public static final java.lang.String SIMPLE_STYLE_PROP

See Also:

Constant Field Values

project

protected final JkProject project

compileDeps

public final java.util.List<java.lang.String> compileDeps

runtimeDeps

public final java.util.List<java.lang.String> runtimeDeps

testDeps

public final java.util.List<java.lang.String> testDeps

Method Detail

of

public static JkProjectScaffold of(JkProject project)

addCustomizer

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

Registers for customizers that will be applied at #run execution.

getTemplate

public JkProjectScaffold.Kind getTemplate()

Returns the template currently set for this scaffold

setKind

public JkProjectScaffold setKind(JkProjectScaffold.Kind kind)

Sets the template for this scaffold.

setUseSimpleStyle

public JkProjectScaffold setUseSimpleStyle(boolean useSimpleStyle)

setGenerateLibsFolders

public JkProjectScaffold setGenerateLibsFolders(boolean generateLibsFolders)

getSrcRelPath

public java.lang.String getSrcRelPath()

getResRelPath

public java.lang.String getResRelPath()

getTestRelPath

public java.lang.String getTestRelPath()

getTestResPath

public java.lang.String getTestResPath()

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

removeFileEntry

public void removeFileEntry(java.lang.String relativePath)

Removes a file entry from the list of file entries. This gives a chance to plugins to remove the non-necessary files.

Parameters:

relativePath - the path, relative to base dir.