dev.jeka.core.tool

Class JkJekaVersionRanges

java.lang.Object

dev.jeka.core.tool.JkJekaVersionRanges

public final class JkJekaVersionRanges
extends java.lang.Object

A utility class to check if the Jeka related classes imported in Jeka classpath are compatible with the running Jeka version.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MANIFEST_BREAKING_CHANGE_URL_ENTRY When publishing a plugin, authors can not guess which future version of Jeka will break compatibility.
static java.lang.String	MANIFEST_LOWEST_JEKA_COMPATIBLE_VERSION_ENTRY Manifest entry containing the lowest Jeka version which is compatible with a plugin.

Method Summary

Modifier and Type	Method and Description
static java.util.function.Consumer<JkManifest>	manifestCustomizer(java.lang.String lowestVersion, java.lang.String breakingChangeUrl) Sets the custom compatibility range for a JkManifest object.
static void	setCompatibilityRange(JkManifest manifest, java.lang.String lowestVersion, java.lang.String breakingChangeUrl) Convenient method to set a Jeka Plugin compatibility range with Jeka versions.

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_BREAKING_CHANGE_URL_ENTRY

public static final java.lang.String MANIFEST_BREAKING_CHANGE_URL_ENTRY

When publishing a plugin, authors can not guess which future version of Jeka will break compatibility. To keep track of breaking change, a registry can be maintained to be accessible at the specified url.

The register is expected to be a simple flat file. Each row is structured as pluginVersion : jekaVersion.

The example below means that :

• Every plugin version equal or lower than 1.2.1.RELEASE is incompatible with any version of jeka equals or greater than 0.9.1.RELEASE
• Every plugin version equal or lower than 1.3.0.RELEASE is incompatible with any version of jeka equals or greater than 0.9.5.M1

     1.2.1.RELEASE : 0.9.1.RELEASE
     1.3.0.RELEASE : 0.9.5.M1
 

See Also:

Constant Field Values

MANIFEST_LOWEST_JEKA_COMPATIBLE_VERSION_ENTRY

public static final java.lang.String MANIFEST_LOWEST_JEKA_COMPATIBLE_VERSION_ENTRY

Manifest entry containing the lowest Jeka version which is compatible with a plugin. If value not null and running Jeka version is lower then a warning log will be emitted.

See Also:

Constant Field Values

Method Detail

setCompatibilityRange

public static void setCompatibilityRange(JkManifest manifest,
                                         java.lang.String lowestVersion,
                                         java.lang.String breakingChangeUrl)

Convenient method to set a Jeka Plugin compatibility range with Jeka versions.

Parameters:

lowestVersion - Can be null

breakingChangeUrl - Can be null

See Also:

MANIFEST_LOWEST_JEKA_COMPATIBLE_VERSION_ENTRY

manifestCustomizer

public static java.util.function.Consumer<JkManifest> manifestCustomizer(java.lang.String lowestVersion,
                                                                         java.lang.String breakingChangeUrl)

Sets the custom compatibility range for a JkManifest object.