org.apache.maven.api

Interface Artifact

All Known Subinterfaces:

Dependency

@Experimental
 @Immutable
public interface Artifact

An artifact points to a resource such as a jar file or war application.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
String	getArtifactId() The artifactId of the artifact.
String	getClassifier() The classifier of the artifact.
String	getExtension() The file extension of the artifact.
String	getGroupId() The groupId of the artifact.
Version	getVersion() The version of the artifact.
boolean	isSnapshot() Determines whether this artifact uses a snapshot version.
default String	key() Returns a unique identifier for this artifact.
ArtifactCoordinate	toCoordinate() Shortcut for session.createArtifactCoordinate(artifact)

Method Detail

key

default String key()

Returns a unique identifier for this artifact. The identifier is composed of groupId, artifactId, version, classifier, extension

Returns:

the unique identifier

getGroupId

@Nonnull
String getGroupId()

The groupId of the artifact.

Returns:

The groupId.

getArtifactId

@Nonnull
String getArtifactId()

The artifactId of the artifact.

Returns:

The artifactId.

getVersion

@Nonnull
Version getVersion()

The version of the artifact.

Returns:

The version.

getClassifier

@Nonnull
String getClassifier()

The classifier of the artifact.

Returns:

The classifier or an empty string if none, never null.

getExtension

@Nonnull
String getExtension()

The file extension of the artifact.

Returns:

The extension.

isSnapshot

boolean isSnapshot()

Determines whether this artifact uses a snapshot version.

Returns:

true if the artifact is a snapshot, false otherwise.

See Also:

Session.isVersionSnapshot(String)

toCoordinate

@Nonnull
ArtifactCoordinate toCoordinate()

Shortcut for session.createArtifactCoordinate(artifact)

Returns:

an ArtifactCoordinate

See Also:

Session.createArtifactCoordinate(Artifact)