dev.jeka.core.api.depmanagement

Class JkDependencySetModifier

java.lang.Object

dev.jeka.core.api.depmanagement.JkDependencySetModifier

public class JkDependencySetModifier
extends java.lang.Object

This class allows modifying a JkDependencySet using a series of method calls.

Method Summary

Modifier and Type	Method and Description
JkDependencySetModifier	add(JkCoordinate coordinates) Adds a JkCoordinate to the JkDependencySetModifier.
JkDependencySetModifier	add(JkDependency dependency) Adds a dependency to the JkDependencySetModifier.
JkDependencySetModifier	add(JkDependencySet.Hint hint, java.lang.String coordinate) Adds a dependency to the JkDependencySetModifier.
JkDependencySetModifier	add(java.nio.file.Path file) Adds a file-based dependency to the JkDependencySetModifier.
JkDependencySetModifier	add(java.lang.String coordinate, JkTransitivity transitivity, java.lang.Object... tokens) Adds a dependency to the JkDependencySetModifier.
JkDependencySetModifier	add(java.lang.String coordinate, java.lang.Object... tokens) Adds a dependency to the JkDependencySetModifier.
JkDependencySetModifier	addVersionProvider(JkVersionProvider versionProvider) Adds a version provider to the JkDependencySetModifier.
JkDependencySetModifier	addWithExclusions(java.lang.String coordinate, java.lang.String... exclusions) Adds a dependency to the JkDependencySetModifier with exclusions.
JkDependencySet	get() Compiutes a JkDependencySet by applying the modifier function to an empty set.
JkDependencySetModifier	modify(java.util.function.Function<JkDependencySet,JkDependencySet> modifier) Modifies the JkDependencySet using the provided modifier function.
JkDependencySetModifier	move(java.lang.String moduleId, JkDependencySet.Hint hint) Moves a dependency within the JkDependencySetModifier,.
static JkDependencySetModifier	of() Returns a new instance of JkDependencySetModifier.
JkDependencySetModifier	remove(java.nio.file.Path file) Removes a file-based dependency from the JkDependencySetModifier.
JkDependencySetModifier	remove(java.lang.String moduleId) Removes a dependency from the JkDependencySetModifier.
JkDependencySetModifier	removeAll() Removes all dependencies from the JkDependencySetModifier.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkDependencySetModifier of()

Returns a new instance of JkDependencySetModifier.

add

public JkDependencySetModifier add(java.lang.String coordinate,
                                   java.lang.Object... tokens)

Adds a dependency to the JkDependencySetModifier.

Parameters:

coordinate - the dependency coordinate in the format of group:artifactId:version

tokens - the tokens for formatting the coordinate (in case of variable version for instance)

addWithExclusions

public JkDependencySetModifier addWithExclusions(java.lang.String coordinate,
                                                 java.lang.String... exclusions)

Adds a dependency to the JkDependencySetModifier with exclusions.

Parameters:

coordinate - the dependency coordinate in the format of group:artifactId:version

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

move

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

Moves a dependency within the JkDependencySetModifier,. This is used to alter the order in which dependencies should be declared.

add

public JkDependencySetModifier add(JkCoordinate coordinates)

Adds a JkCoordinate to the JkDependencySetModifier.

add

public JkDependencySetModifier add(java.nio.file.Path file)

Adds a file-based dependency to the JkDependencySetModifier.

add

public JkDependencySetModifier add(JkDependency dependency)

Adds a dependency to the JkDependencySetModifier.

add

public JkDependencySetModifier add(java.lang.String coordinate,
                                   JkTransitivity transitivity,
                                   java.lang.Object... tokens)

Adds a dependency to the JkDependencySetModifier.

Parameters:

coordinate - the dependency coordinate in the format of group:artifactId:version

transitivity - the transitivity of the dependency

tokens - the tokens for formatting the coordinate (in case of variable version for instance)

add

public JkDependencySetModifier add(JkDependencySet.Hint hint,
                                   java.lang.String coordinate)

Adds a dependency to the JkDependencySetModifier.

Parameters:

hint - the hint for prioritizing the dependency

coordinate - the dependency coordinate in the format of group:artifactId:version

addVersionProvider

public JkDependencySetModifier addVersionProvider(JkVersionProvider versionProvider)

Adds a version provider to the JkDependencySetModifier.

remove

public JkDependencySetModifier remove(java.lang.String moduleId)

Removes a dependency from the JkDependencySetModifier.

Parameters:

moduleId - the module id of the dependency to be removed (e.g a.group:a-module)

removeAll

public JkDependencySetModifier removeAll()

Removes all dependencies from the JkDependencySetModifier.

remove

public JkDependencySetModifier remove(java.nio.file.Path file)

Removes a file-based dependency from the JkDependencySetModifier.

Parameters:

file - the file representing the dependency to be removed

modify

public JkDependencySetModifier modify(java.util.function.Function<JkDependencySet,JkDependencySet> modifier)

Modifies the JkDependencySet using the provided modifier function. The modifier function takes a JkDependencySet as input and returns a modified JkDependencySet.

Parameters:

modifier - the function used to modify the JkDependencySet

get

public JkDependencySet get()

Compiutes a JkDependencySet by applying the modifier function to an empty set.