dev.jeka.core.api.depmanagement.publication

Class JkIvyPublication

java.lang.Object

dev.jeka.core.api.depmanagement.publication.JkIvyPublication

public final class JkIvyPublication
extends java.lang.Object

Information required to publish a module in an Ivy repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkIvyPublication.JkIvyPublishedArtifact

Field Summary

Fields

Modifier and Type	Field and Description
JkRunnables	postActions
JkRunnables	preActions

Method Summary

Modifier and Type	Method and Description
JkIvyPublication	addRepos(JkRepo... repoArgs) Adds the specified repositories to the publication repositories.
JkIvyPublication	configureDependencies(java.util.function.UnaryOperator<JkQualifiedDependencySet> modifier) Configure the dependencies that will be exported with the published module. By default, JeKa computes it from the compile and runtime dependencies.
JkRepo	findFirstNonLocalRepo() Shorthand to get the first declared publication repository.
java.util.List<JkIvyPublication.JkIvyPublishedArtifact>	getAllArtifacts()
JkFileSigner	getDefaultSigner() Returns the default file signer for this publication.
JkQualifiedDependencySet	getDependencies() Returns the transitive dependencies for this publication
JkModuleId	getModuleId() Returns the moduleId (group + artifact name) for this publication.
static JkQualifiedDependencySet	getPublishDependencies(JkDependencySet compileDependencies, JkDependencySet runtimeDependencies, JkCoordinate.ConflictStrategy strategy)
JkRepoSet	getRepos() Returns the repositories where this publication will be published.
JkVersion	getVersion() Returns the version of the artifacts for this publication.
java.lang.String	info()
static JkIvyPublication	of() Creates a JkIvyPublication.
JkIvyPublication	publish()
JkIvyPublication	publishLocal()
JkIvyPublication	putArtifact(java.lang.String artifactName, java.nio.file.Path artifactFile, java.lang.String... configurationNames) Adds the specified artifact to the publication.
JkIvyPublication	putArtifactWithType(java.lang.String artifactName, java.nio.file.Path artifactFile, java.lang.String type, java.lang.String... configurationNames) Adds the specified artifact to the publication.
JkIvyPublication	putMainArtifact(java.nio.file.Path file, java.lang.String... configurationNames)
JkIvyPublication	putMainArtifactWithType(java.nio.file.Path file, java.lang.String type, java.lang.String... configurationNames)
JkIvyPublication	putOptionalArtifact(java.nio.file.Path file, java.lang.String... configurationNames) Same as putMainArtifact(Path, String...) (Path, String...) but effective only if the specified file exists.
JkIvyPublication	putOptionalArtifactWithType(java.nio.file.Path file, java.lang.String type, java.lang.String... configurationNames) Same as putMainArtifact(Path, String...) (Path, String, String...) but effective only if the specified file exists.
JkIvyPublication	setBomResolutionRepos(java.util.function.Supplier<JkRepoSet> repoSupplier) Sets the supplier providing the download repositories used to resolve BOMs.
JkIvyPublication	setDefaultSigner(JkFileSigner defaultSigner) Sets the default file signer to use for this publication.
JkIvyPublication	setDependencies(JkDependencySet allCompileDeps, JkDependencySet allRuntimeDeps, JkDependencySet allTestDeps) Sets transitive dependencies for this publication.
JkIvyPublication	setDependencies(JkDependencySet allCompileDeps, JkDependencySet allRuntimeDeps, JkDependencySet allTestDeps, JkCoordinate.ConflictStrategy conflictStrategy) Sets transitive dependencies for this publication.
JkIvyPublication	setDependencies(JkQualifiedDependencySet configuredDependencies) Sets transitive dependencies for this publication.
JkIvyPublication	setModuleId(java.lang.String moduleId) Sets the moduleId (group + artifactName) for this publication.
JkIvyPublication	setModuleIdSupplier(java.util.function.Supplier<JkModuleId> moduleIdSupplier) Sets the supplier providing the moduleId (group + artifactName) for this publication.
JkIvyPublication	setRepos(JkRepoSet repos) Sets the repositories where this publication will be published.
JkIvyPublication	setVersion(java.lang.String version) Sets the version of the artifacts to publish.
JkIvyPublication	setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier) Sets the supplier providing the version of the artifacts to publish.

Methods inherited from class java.lang.Object

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

Field Detail

preActions

public final JkRunnables preActions

postActions

public final JkRunnables postActions

Method Detail

of

public static JkIvyPublication of()

Creates a JkIvyPublication.

configureDependencies

public JkIvyPublication configureDependencies(java.util.function.UnaryOperator<JkQualifiedDependencySet> modifier)

Configure the dependencies that will be exported with the published module.
By default, JeKa computes it from the compile and runtime dependencies. This method allows to customize these dependencies by adding/removing or changing their transitivity.

setDependencies

public JkIvyPublication setDependencies(JkQualifiedDependencySet configuredDependencies)

Sets transitive dependencies for this publication.

setDependencies

public JkIvyPublication setDependencies(JkDependencySet allCompileDeps,
                                        JkDependencySet allRuntimeDeps,
                                        JkDependencySet allTestDeps,
                                        JkCoordinate.ConflictStrategy conflictStrategy)

Sets transitive dependencies for this publication.

setDependencies

public JkIvyPublication setDependencies(JkDependencySet allCompileDeps,
                                        JkDependencySet allRuntimeDeps,
                                        JkDependencySet allTestDeps)

Sets transitive dependencies for this publication.

getDependencies

public JkQualifiedDependencySet getDependencies()

Returns the transitive dependencies for this publication

setModuleIdSupplier

public JkIvyPublication setModuleIdSupplier(java.util.function.Supplier<JkModuleId> moduleIdSupplier)

Sets the supplier providing the moduleId (group + artifactName) for this publication.

setModuleId

public JkIvyPublication setModuleId(java.lang.String moduleId)

Sets the moduleId (group + artifactName) for this publication.

See Also:

setModuleIdSupplier(Supplier)

setVersionSupplier

public JkIvyPublication setVersionSupplier(java.util.function.Supplier<JkVersion> versionSupplier)

Sets the supplier providing the version of the artifacts to publish.

setVersion

public JkIvyPublication setVersion(java.lang.String version)

Sets the version of the artifacts to publish.

See Also:

setVersionSupplier(Supplier)

setBomResolutionRepos

public JkIvyPublication setBomResolutionRepos(java.util.function.Supplier<JkRepoSet> repoSupplier)

Sets the supplier providing the download repositories used to resolve BOMs.

getModuleId

public JkModuleId getModuleId()

Returns the moduleId (group + artifact name) for this publication.

getVersion

public JkVersion getVersion()

Returns the version of the artifacts for this publication.

getDefaultSigner

public JkFileSigner getDefaultSigner()

Returns the default file signer for this publication.

Normally, each publish repository can define its own signer. Conveniently we can specify a file signer for repositories which don't have.

setDefaultSigner

public JkIvyPublication setDefaultSigner(JkFileSigner defaultSigner)

Sets the default file signer to use for this publication.

See Also:

getDefaultSigner()

getRepos

public JkRepoSet getRepos()

Returns the repositories where this publication will be published.

setRepos

public JkIvyPublication setRepos(JkRepoSet repos)

Sets the repositories where this publication will be published.

addRepos

public JkIvyPublication addRepos(JkRepo... repoArgs)

Adds the specified repositories to the publication repositories.

See Also:

setRepos(JkRepoSet)

putMainArtifact

public JkIvyPublication putMainArtifact(java.nio.file.Path file,
                                        java.lang.String... configurationNames)

See Also:

putArtifactWithType(String, Path, String, String...)

putMainArtifactWithType

public JkIvyPublication putMainArtifactWithType(java.nio.file.Path file,
                                                java.lang.String type,
                                                java.lang.String... configurationNames)

See Also:

putArtifactWithType(String, Path, String, String...)

putArtifactWithType

public JkIvyPublication putArtifactWithType(java.lang.String artifactName,
                                            java.nio.file.Path artifactFile,
                                            java.lang.String type,
                                            java.lang.String... configurationNames)

Adds the specified artifact to the publication.

putArtifact

public JkIvyPublication putArtifact(java.lang.String artifactName,
                                    java.nio.file.Path artifactFile,
                                    java.lang.String... configurationNames)

Adds the specified artifact to the publication.

putOptionalArtifact

public JkIvyPublication putOptionalArtifact(java.nio.file.Path file,
                                            java.lang.String... configurationNames)

Same as putMainArtifact(Path, String...) (Path, String...) but effective only if the specified file exists.

putOptionalArtifactWithType

public JkIvyPublication putOptionalArtifactWithType(java.nio.file.Path file,
                                                    java.lang.String type,
                                                    java.lang.String... configurationNames)

Same as putMainArtifact(Path, String...) (Path, String, String...) but effective only if the specified file exists.

getAllArtifacts

public java.util.List<JkIvyPublication.JkIvyPublishedArtifact> getAllArtifacts()

publish

public JkIvyPublication publish()

publishLocal

public JkIvyPublication publishLocal()

findFirstNonLocalRepo

public JkRepo findFirstNonLocalRepo()

Shorthand to get the first declared publication repository.

info

public java.lang.String info()

getPublishDependencies

public static JkQualifiedDependencySet getPublishDependencies(JkDependencySet compileDependencies,
                                                              JkDependencySet runtimeDependencies,
                                                              JkCoordinate.ConflictStrategy strategy)