dev.vankka.dependencydownload.dependency

Interface Dependency

All Known Implementing Classes:

SnapshotDependency, StandardDependency

public interface Dependency

A maven dependency.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAVEN_PATH_FORMAT

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getArtifactId() The artifact id of the dependency.
@Nullable java.lang.String	getClassifier() The classifier for the dependency artifact, if any.
default @NotNull java.lang.String	getFileName() Returns the file name for the end of the maven path.
@NotNull java.lang.String	getGroupId() The group id of the dependency.
@NotNull java.lang.String	getHash() The hash of the dependency, this is checked against the downloaded file.
@NotNull java.lang.String	getHashingAlgorithm() The hashing algorithm used for the getHash().
default @NotNull java.lang.String	getMavenArtifact() Gets the group id, artifact id, version and classifier (if specified) seperated by semicolons.
default @NotNull java.lang.String	getMavenPath() The path to this dependency on a maven repository, without the protocol, domain or slash at the beginning.
@Nullable java.lang.String	getSnapshotVersion() The timestamped snapshot version.
default @NotNull java.lang.String	getStoredFileName() Returns the file name when stored to disk.
@NotNull java.lang.String	getVersion() The version of the dependency.
boolean	isSnapshot() If this is a snapshot dependency.

Field Detail

MAVEN_PATH_FORMAT

static final java.lang.String MAVEN_PATH_FORMAT

See Also:

Constant Field Values

Method Detail

getGroupId

@NotNull
@NotNull java.lang.String getGroupId()

The group id of the dependency.

Returns:

the dependency's group id

getArtifactId

@NotNull
@NotNull java.lang.String getArtifactId()

The artifact id of the dependency.

Returns:

the dependency's artifact id

getVersion

@NotNull
@NotNull java.lang.String getVersion()

The version of the dependency.

Returns:

the dependency's version

getClassifier

@Nullable
@Nullable java.lang.String getClassifier()

The classifier for the dependency artifact, if any.

Returns:

the dependency artifact's classifier or null.

getSnapshotVersion

@Nullable
@Nullable java.lang.String getSnapshotVersion()

The timestamped snapshot version.

Returns:

the timestamped snapshot version or null if this isn't a snapshot dependency.

See Also:

isSnapshot()

getHash

@NotNull
@NotNull java.lang.String getHash()

The hash of the dependency, this is checked against the downloaded file.

Returns:

the hash of the dependency archive

See Also:

getHashingAlgorithm()

getHashingAlgorithm

@NotNull
@NotNull java.lang.String getHashingAlgorithm()

The hashing algorithm used for the getHash().

Returns:

the hashing algorithm used for the dependency archive's hash

See Also:

getHash()

isSnapshot

boolean isSnapshot()

If this is a snapshot dependency.

Returns:

true if this dependency is a snapshot

getFileName

@NotNull
default @NotNull java.lang.String getFileName()

Returns the file name for the end of the maven path.

Returns:

the file name for the dependency

getStoredFileName

@NotNull
default @NotNull java.lang.String getStoredFileName()

Returns the file name when stored to disk.

Returns:

the file name for storing the dependency

getMavenPath

@NotNull
default @NotNull java.lang.String getMavenPath()

The path to this dependency on a maven repository, without the protocol, domain or slash at the beginning.

Returns:

the path to this dependency's jar file on a maven repository

getMavenArtifact

@NotNull
default @NotNull java.lang.String getMavenArtifact()

Gets the group id, artifact id, version and classifier (if specified) seperated by semicolons.

Returns:

the maven artifact's GAV and classifier parameters seperated by semicolons (:)