dev.jeka.core.api.scaffold

Class JkScaffold

java.lang.Object

dev.jeka.core.api.scaffold.JkScaffold

Direct Known Subclasses:

JkBaseScaffold, JkProjectScaffold

public abstract class JkScaffold
extends java.lang.Object

Object that process scaffolding.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkScaffold.JkFileEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	baseDir
java.util.List<JkScaffold.JkFileEntry>	fileEntries
static java.lang.String	UNSPECIFIED_JEKA_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JkScaffold(java.nio.file.Path baseDir)
protected	JkScaffold(java.nio.file.Path baseDir, JkRepoSet downloadRepos)

Method Summary

Modifier and Type	Method and Description
void	addFileEntry(java.lang.String relativePath, java.lang.String content) Adds a file entry to the list of file entries in the scaffold.
JkScaffold	addJekaPropsContent(java.lang.String extraContent)
JkScaffold	addJekaPropValue(java.lang.String propValue) Adds a property to scaffolded jeka.properties by specifying a string with format "prop.name=prop.value".
static void	createShellScripts(java.nio.file.Path baseDir) Creates or replaces shell scripts in the specified base directory, meaning jeka.ps1 and jeka bash scripts.
java.lang.String	findLatestStableVersion(java.lang.String moduleCoordinate, java.lang.String defaultVersion) Finds the latest version for a given module coordinate.
protected java.lang.String	getJekaVersion()
protected java.util.List<java.lang.String>	getJUnitDeps()
java.lang.String	lastJekaVersion() Returns the last version of the Jeka module.
static java.lang.String	readResource(java.lang.Class<?> clazz, java.lang.String resourceName) Returns the content of a resource file as a string.
void	removeFileEntriesStartingWith(java.nio.file.Path pathPrefix) Removes the file entries that start with the specified path prefix.
protected void	run() Runs the scaffolding, meaning folder structure, build class, props file and .gitignore
JkScaffold	setJekaDistribLocation(java.lang.String jekaDistribLocation)
JkScaffold	setJekaDistribRepo(java.lang.String jekaDistribRepo)
JkScaffold	setJekaPropsCustomizer(java.util.function.UnaryOperator<java.lang.String> customizer) Gives a chance to override the final jeka.properties file
JkScaffold	setJekaVersion(java.lang.String jekaVersion)
JkScaffold	setRawJekaPropsPath(java.nio.file.Path rawJekaPropsPath) Sets the path of a file that will be copied to jeka.properties.

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED_JEKA_VERSION

public static final java.lang.String UNSPECIFIED_JEKA_VERSION

See Also:

Constant Field Values

baseDir

protected final java.nio.file.Path baseDir

fileEntries

public final java.util.List<JkScaffold.JkFileEntry> fileEntries

Constructor Detail

JkScaffold

protected JkScaffold(java.nio.file.Path baseDir,
                     JkRepoSet downloadRepos)

JkScaffold

protected JkScaffold(java.nio.file.Path baseDir)

Method Detail

addJekaPropsContent

public JkScaffold addJekaPropsContent(java.lang.String extraContent)

addJekaPropValue

public JkScaffold addJekaPropValue(java.lang.String propValue)

Adds a property to scaffolded jeka.properties by specifying a string with format "prop.name=prop.value".

setJekaVersion

public JkScaffold setJekaVersion(java.lang.String jekaVersion)

setRawJekaPropsPath

public JkScaffold setRawJekaPropsPath(java.nio.file.Path rawJekaPropsPath)

Sets the path of a file that will be copied to jeka.properties.

If such a path is set, all other settings related to jeka.properties generation are ignored and the content of jeka.properties will be exactly the same as the specified file.

setJekaDistribRepo

public JkScaffold setJekaDistribRepo(java.lang.String jekaDistribRepo)

setJekaDistribLocation

public JkScaffold setJekaDistribLocation(java.lang.String jekaDistribLocation)

findLatestStableVersion

public java.lang.String findLatestStableVersion(java.lang.String moduleCoordinate,
                                                java.lang.String defaultVersion)

Finds the latest version for a given module coordinate. If the latest version cannot be found or an exception occurs, the method returns the default version.

Parameters:

moduleCoordinate - the coordinate of the module for which to find the latest version

defaultVersion - the default version to be returned if the latest version cannot be found

getJUnitDeps

protected java.util.List<java.lang.String> getJUnitDeps()

getJekaVersion

protected java.lang.String getJekaVersion()

run

protected void run()

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

lastJekaVersion

public final java.lang.String lastJekaVersion()

Returns the last version of the Jeka module.

This method searches for versions of the Jeka module in the specified download repositories. It filters out any snapshot versions and returns the last non-snapshot version found. If no versions are found, it logs a warning message and returns the current Jeka version.

Returns:

the last version of the Jeka module

setJekaPropsCustomizer

public JkScaffold setJekaPropsCustomizer(java.util.function.UnaryOperator<java.lang.String> customizer)

Gives a chance to override the final jeka.properties file

addFileEntry

public final void addFileEntry(java.lang.String relativePath,
                               java.lang.String content)

Adds a file entry to the list of file entries in the scaffold. The file entry consists of a relative path and its content. The file entry will be created or updated when the scaffold is run.

removeFileEntriesStartingWith

public final void removeFileEntriesStartingWith(java.nio.file.Path pathPrefix)

Removes the file entries that start with the specified path prefix.

readResource

public static java.lang.String readResource(java.lang.Class<?> clazz,
                                            java.lang.String resourceName)

Returns the content of a resource file as a string.

createShellScripts

public static void createShellScripts(java.nio.file.Path baseDir)

Creates or replaces shell scripts in the specified base directory, meaning jeka.ps1 and jeka bash scripts.

Parameters:

baseDir - the base directory where the shell scripts will be created or replaced.