dev.jeka.core.api.depmanagement

Class JkDependencySet

java.lang.Object

dev.jeka.core.api.depmanagement.JkDependencySet

public class JkDependencySet
extends java.lang.Object

A set of JkDependency generally standing for a given purpose (compile, test, runtime) in a project build.

JkDependencySet also holds a JkVersionProvider and a set of JkDependencyExclusion.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkDependencySet.Hint

Method Summary

Modifier and Type	Method and Description
JkDependencySet	and(JkCoordinate coordinate)
JkDependencySet	and(JkDependency... others)
JkDependencySet	and(JkDependencySet.Hint hint, JkCoordinate coordinate)
JkDependencySet	and(JkDependencySet.Hint hint, JkDependency... others)
JkDependencySet	and(JkDependencySet.Hint hint, JkDependencySet other) Returns a clone of this object plus the specified JkDependencys, at the specified place and condition.
JkDependencySet	and(JkDependencySet.Hint hint, JkModuleId jkModuleId)
JkDependencySet	and(JkDependencySet.Hint hint, java.util.List<? extends JkDependency> others)
JkDependencySet	and(JkDependencySet.Hint hint, java.lang.String coordinate, JkTransitivity transitivity, java.lang.Object... tokens)
JkDependencySet	and(JkDependencySet.Hint hint, java.lang.String coordinate, java.lang.Object... tokens)
JkDependencySet	and(JkDependencySet other)
JkDependencySet	and(JkModuleId jkModuleId)
JkDependencySet	and(java.util.List<? extends JkDependency> others) Returns a clone of this object plus the specified JkDependencys at the tail of this one.
JkDependencySet	and(java.lang.String coordinate, JkTransitivity transitivity, java.lang.Object... tokens)
JkDependencySet	and(java.lang.String coordinate, java.lang.Object... tokens)
JkDependencySet	andFiles(java.lang.Iterable<java.nio.file.Path> paths)
JkDependencySet	andFiles(JkDependencySet.Hint hint, java.lang.Iterable<java.nio.file.Path> paths)
JkDependencySet	andFiles(JkDependencySet.Hint hint, java.lang.String... paths)
JkDependencySet	andFiles(java.lang.String... paths)
JkDependencySet	andGlobalExclusion(JkDependencyExclusion exclusion)
JkDependencySet	andGlobalExclusion(java.lang.String moduleId)
JkDependencySet	andVersionProvider(JkVersionProvider versionProvider) Returns a clone of this object but using specified version provider to override versions of transitive dependencies.
JkDependencySet	assertNoUnspecifiedVersion() Throws a IllegalStateException if one of the module dependencies has an unspecified version.
JkCoordinateDependency	get(java.lang.String moduleId) Returns the JkDependency declared for the specified JkModuleId.
java.util.List<JkCoordinateDependency>	getCoordinateDependencies()
java.util.List<JkDependency>	getEntries() Returns the unmodifiable list of scoped dependencies for this object.
java.util.LinkedHashSet<JkDependencyExclusion>	getGlobalExclusions() Returns the dependencies to be excluded to the transitive chain when using this dependency.
java.util.Set<java.nio.file.Path>	getIdePathDirs()
<T extends JkDependency> T	getMatching(T dependency)
java.util.List<JkDependency>	getVersionedDependencies() Returns all dependencies, adding versionProvider versions to module dependencies that does not specify one.
JkVersionProvider	getVersionProvider() Returns overridden versions for transitive dependencies and direct dependencies with no version specified on.
java.util.List<JkCoordinateDependency>	getVersionResolvedCoordinateDependencies()
boolean	hasDynamicAndResolvableVersions() Returns true if this object contains dependency on external module whose rely on dynamic version that are resolvable (Maven Snapshot versions are dynamic but not resolvable).
boolean	hasDynamicVersions() Returns true if this object contains dependency on external module whose rely on dynamic version.
boolean	hasModules() Returns true if this object contains dependencies whose are JkCoordinateDependency.
JkDependencySetMerge	merge(JkDependencySet other)
JkDependencySet	mergeLocalProjectExportedDependencies()
JkDependencySet	minus(JkDependency dependency)
JkDependencySet	minus(JkModuleId jkModuleId)
JkDependencySet	minus(java.util.List<JkDependency> dependencies)
JkDependencySet	minus(java.nio.file.Path path)
JkDependencySet	minus(java.lang.String moduleId)
JkDependencySet	minusModuleDependenciesHavingIdeProjectDir()
JkDependencySet	normalised()
JkDependencySet	normalised(JkCoordinate.ConflictStrategy conflictStrategy) Removes duplicates and select a version according the specified strategy in case of duplicate with distinct versions.
static JkDependencySet	of()
static JkDependencySet	of(JkDependency dependency)
static JkDependencySet	of(java.util.List<? extends JkDependency> dependencies) Creates a JkDependencySet to the specified scoped dependencies.
static JkDependencySet	of(java.lang.String coordinateOrFile)
static java.lang.String	toJavaCode(int indentCount, java.util.List<JkDependency> dependencies, boolean and) Returns the java codes that declare these dependencies.
JkDependencySet	toResolvedModuleVersions() Fills the dependencies without specified version with the version supplied by the JkVersionProvider.
java.lang.String	toString()
static java.lang.String	toTxt(java.util.List<JkDependency> dependencies, boolean minus)
JkDependencySet	withGlobalExclusions(java.util.List<JkDependencyExclusion> excludes)
JkDependencySet	withGlobalExclusions(java.lang.String... moduleIds)
JkDependencySet	withGlobalTransitivityReplacement(JkTransitivity formerTransitivity, JkTransitivity newTransitivity)
JkDependencySet	withIdeProjectDir(java.nio.file.Path ideProjectDir)
JkDependencySet	withLocalExclusions(JkDependencyExclusion... exclusions) Returns a clone of this dependencySet but adding dependency exclusion on the last element.
JkDependencySet	withLocalExclusions(java.lang.String... moduleIds)
JkDependencySet	withLocalExclusionsOn(java.lang.String moduleId, java.lang.String... excludedModules) Add transitive dependency exclusions on the specified module.
JkDependencySet	withModuleDependenciesOnly() Returns all dependencies declared as JkCoordinateDependency.
JkDependencySet	withMoving(java.lang.String moduleId, JkDependencySet.Hint hint)
JkDependencySet	withoutDuplicate()
JkDependencySet	withResolvedBoms(JkRepoSet repos) Returns a clone of this object but using this version provider with bom resolved.
JkDependencySet	withTransitivity(java.lang.String moduleId, JkTransitivity newTransitivity)
JkDependencySet	withVersionProvider(JkVersionProvider versionProvider) Returns a clone of this object but using specified version provider to override versions of transitive dependencies.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkDependencySet of(java.lang.String coordinateOrFile)

of

public static JkDependencySet of()

of

public static JkDependencySet of(java.util.List<? extends JkDependency> dependencies)

Creates a JkDependencySet to the specified scoped dependencies.

of

public static JkDependencySet of(JkDependency dependency)

getEntries

public java.util.List<JkDependency> getEntries()

Returns the unmodifiable list of scoped dependencies for this object.

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           JkDependencySet other)

Returns a clone of this object plus the specified JkDependencys, at the specified place and condition.

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           java.util.List<? extends JkDependency> others)

and

public JkDependencySet and(java.util.List<? extends JkDependency> others)

Returns a clone of this object plus the specified JkDependencys at the tail of this one.

and

public JkDependencySet and(JkDependencySet other)

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           JkDependency... others)

and

public JkDependencySet and(JkDependency... others)

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           java.lang.String coordinate,
                           java.lang.Object... tokens)

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           JkModuleId jkModuleId)

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           JkCoordinate coordinate)

and

public JkDependencySet and(JkCoordinate coordinate)

and

public JkDependencySet and(JkModuleId jkModuleId)

and

public JkDependencySet and(java.lang.String coordinate,
                           java.lang.Object... tokens)

and

public JkDependencySet and(JkDependencySet.Hint hint,
                           java.lang.String coordinate,
                           JkTransitivity transitivity,
                           java.lang.Object... tokens)

and

public JkDependencySet and(java.lang.String coordinate,
                           JkTransitivity transitivity,
                           java.lang.Object... tokens)

andFiles

public JkDependencySet andFiles(JkDependencySet.Hint hint,
                                java.lang.Iterable<java.nio.file.Path> paths)

andFiles

public JkDependencySet andFiles(java.lang.Iterable<java.nio.file.Path> paths)

andFiles

public JkDependencySet andFiles(JkDependencySet.Hint hint,
                                java.lang.String... paths)

andFiles

public JkDependencySet andFiles(java.lang.String... paths)

minus

public JkDependencySet minus(java.util.List<JkDependency> dependencies)

minus

public JkDependencySet minus(JkDependency dependency)

minus

public JkDependencySet minus(java.nio.file.Path path)

minus

public JkDependencySet minus(JkModuleId jkModuleId)

minus

public JkDependencySet minus(java.lang.String moduleId)

withMoving

public JkDependencySet withMoving(java.lang.String moduleId,
                                  JkDependencySet.Hint hint)

withGlobalTransitivityReplacement

public JkDependencySet withGlobalTransitivityReplacement(JkTransitivity formerTransitivity,
                                                         JkTransitivity newTransitivity)

withTransitivity

public JkDependencySet withTransitivity(java.lang.String moduleId,
                                        JkTransitivity newTransitivity)

withLocalExclusionsOn

public JkDependencySet withLocalExclusionsOn(java.lang.String moduleId,
                                             java.lang.String... excludedModules)

Add transitive dependency exclusions on the specified module.

Parameters:

moduleId - The module id where we want to add exclusions.

excludedModules - The modules to exclude from transitive dependencies.

mergeLocalProjectExportedDependencies

public JkDependencySet mergeLocalProjectExportedDependencies()

withVersionProvider

public JkDependencySet withVersionProvider(JkVersionProvider versionProvider)

Returns a clone of this object but using specified version provider to override versions of transitive dependencies. The previous version provider is replaced by the specified one, there is no addition.

withResolvedBoms

public JkDependencySet withResolvedBoms(JkRepoSet repos)

Returns a clone of this object but using this version provider with bom resolved.

andVersionProvider

public JkDependencySet andVersionProvider(JkVersionProvider versionProvider)

Returns a clone of this object but using specified version provider to override versions of transitive dependencies. The specified version provider is added to the specified one.

hasModules

public boolean hasModules()

Returns true if this object contains dependencies whose are JkCoordinateDependency.

getVersionProvider

public JkVersionProvider getVersionProvider()

Returns overridden versions for transitive dependencies and direct dependencies with no version specified on.

Versions present here will overwrite versions found in transitive dependencies and un-versioned direct dependencies.

Versions present in direct dependencies won't be overridden.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public JkCoordinateDependency get(java.lang.String moduleId)

Returns the JkDependency declared for the specified JkModuleId. Returns null if no dependency on this module exists in this object.

getMatching

public <T extends JkDependency> T getMatching(T dependency)

getCoordinateDependencies

public java.util.List<JkCoordinateDependency> getCoordinateDependencies()

hasDynamicVersions

public boolean hasDynamicVersions()

Returns true if this object contains dependency on external module whose rely on dynamic version. It can be either dynamic version as "1.3.+", "[1.0, 2.0[" ,... or snapshot version as defined in Maven (as "1.0-SNAPSHOT").

hasDynamicAndResolvableVersions

public boolean hasDynamicAndResolvableVersions()

Returns true if this object contains dependency on external module whose rely on dynamic version that are resolvable (Maven Snapshot versions are dynamic but not resolvable). It only stands for dynamic versions as "1.3.+", "[1.0, 2.0[" ,... If so, when resolving, dynamic versions are replaced by fixed resolved ones.

withIdeProjectDir

public JkDependencySet withIdeProjectDir(java.nio.file.Path ideProjectDir)

minusModuleDependenciesHavingIdeProjectDir

public JkDependencySet minusModuleDependenciesHavingIdeProjectDir()

merge

public JkDependencySetMerge merge(JkDependencySet other)

getIdePathDirs

public java.util.Set<java.nio.file.Path> getIdePathDirs()

normalised

public JkDependencySet normalised(JkCoordinate.ConflictStrategy conflictStrategy)

Removes duplicates and select a version according the specified strategy in case of duplicate with distinct versions.

normalised

public JkDependencySet normalised()

assertNoUnspecifiedVersion

public JkDependencySet assertNoUnspecifiedVersion()

Throws a IllegalStateException if one of the module dependencies has an unspecified version.

toResolvedModuleVersions

public JkDependencySet toResolvedModuleVersions()

Fills the dependencies without specified version with the version supplied by the JkVersionProvider.

getVersionedDependencies

public java.util.List<JkDependency> getVersionedDependencies()

Returns all dependencies, adding versionProvider versions to module dependencies that does not specify one.

getVersionResolvedCoordinateDependencies

public java.util.List<JkCoordinateDependency> getVersionResolvedCoordinateDependencies()

withModuleDependenciesOnly

public JkDependencySet withModuleDependenciesOnly()

Returns all dependencies declared as JkCoordinateDependency.

withLocalExclusions

public JkDependencySet withLocalExclusions(JkDependencyExclusion... exclusions)

Returns a clone of this dependencySet but adding dependency exclusion on the last element.

withLocalExclusions

public JkDependencySet withLocalExclusions(java.lang.String... moduleIds)

Parameters:

moduleIds - moduleIds to exclude (e.g. "a.group:a.name", "another.group:another.name", ...).

getGlobalExclusions

public java.util.LinkedHashSet<JkDependencyExclusion> getGlobalExclusions()

Returns the dependencies to be excluded to the transitive chain when using this dependency.

andGlobalExclusion

public JkDependencySet andGlobalExclusion(JkDependencyExclusion exclusion)

andGlobalExclusion

public JkDependencySet andGlobalExclusion(java.lang.String moduleId)

withGlobalExclusions

public JkDependencySet withGlobalExclusions(java.util.List<JkDependencyExclusion> excludes)

withGlobalExclusions

public JkDependencySet withGlobalExclusions(java.lang.String... moduleIds)

withoutDuplicate

public JkDependencySet withoutDuplicate()

toJavaCode

public static java.lang.String toJavaCode(int indentCount,
                                          java.util.List<JkDependency> dependencies,
                                          boolean and)

Returns the java codes that declare these dependencies.

toTxt

public static java.lang.String toTxt(java.util.List<JkDependency> dependencies,
                                     boolean minus)