org.jenkinsci.maven.plugins.hpi

Class MavenArtifact

java.lang.Object

org.jenkinsci.maven.plugins.hpi.MavenArtifact

All Implemented Interfaces:

Comparable<MavenArtifact>

public class MavenArtifact
extends Object
implements Comparable<MavenArtifact>

Artifact is a bare data structure without any behavior and therefore hard to write OO programs around it. This class wraps Artifact and adds behaviours.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.maven.artifact.Artifact	artifact
org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
org.apache.maven.project.ProjectBuilder	builder
org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver	resolver
org.apache.maven.execution.MavenSession	session

Constructor Summary

Constructors

Constructor and Description
MavenArtifact(org.apache.maven.artifact.Artifact artifact, org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, org.apache.maven.project.ProjectBuilder builder, org.apache.maven.execution.MavenSession session)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MavenArtifact o)
String	getActualArtifactId() For a plugin artifact, unlike getArtifactId() this parses the plugin manifest.
String	getActualVersion() For a plugin artifact, unlike getVersion() this parses the plugin manifest.
String	getArtifactId() Gets the artifactId as used in a dependency declaration.
String	getClassifier()
String	getDefaultFinalName() Converts the filename of an artifact to artifactId-version.type format.
List<String>	getDependencyTrail()
File	getFile() Resolves to the jar file that contains the code of the plugin.
String	getGroupId()
MavenArtifact	getHpi() Returns MavenArtifact for the hpi variant of this artifact.
String	getId()
String	getScope()
String	getType()
String	getVersion() Gets the version as used in a dependency declaration.
org.apache.maven.artifact.versioning.ArtifactVersion	getVersionNumber()
boolean	hasSameGAAs(org.apache.maven.project.MavenProject project) Returns true if this artifact has the same groupId and artifactId as the given project.
boolean	hasScope(String... scopes) Returns true if the artifacts has one of the given scopes (including null.)
boolean	isNewerThan(MavenArtifact rhs)
boolean	isOptional()
boolean	isPlugin() Is this a Jenkins plugin?
boolean	isPluginBestEffort(org.apache.maven.plugin.logging.Log log) Like isPlugin() but will not throw an exception if the project model cannot be resolved.
org.apache.maven.project.MavenProject	resolvePom()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

artifactFactory

public final org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

builder

public final org.apache.maven.project.ProjectBuilder builder

artifact

public final org.apache.maven.artifact.Artifact artifact

resolver

public final org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver

session

public final org.apache.maven.execution.MavenSession session

Constructor Detail

MavenArtifact

public MavenArtifact(org.apache.maven.artifact.Artifact artifact,
                     org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver,
                     org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                     org.apache.maven.project.ProjectBuilder builder,
                     org.apache.maven.execution.MavenSession session)

Method Detail

resolvePom

public org.apache.maven.project.MavenProject resolvePom()
                                                 throws org.apache.maven.project.ProjectBuildingException

Throws:

org.apache.maven.project.ProjectBuildingException

isPlugin

public boolean isPlugin()
                 throws IOException

Is this a Jenkins plugin?

Throws:

IOException

isPluginBestEffort

public boolean isPluginBestEffort(org.apache.maven.plugin.logging.Log log)

Like isPlugin() but will not throw an exception if the project model cannot be resolved. Helpful for example when an indirect dependency has a bogus systemPath that is only rejected in some environments.

getId

public String getId()

getDefaultFinalName

public String getDefaultFinalName()

Converts the filename of an artifact to artifactId-version.type format.

Returns:

converted filename of the artifact

isOptional

public boolean isOptional()

getType

public String getType()

getFile

public File getFile()

Resolves to the jar file that contains the code of the plugin.

getHpi

public MavenArtifact getHpi()
                     throws IOException

Returns MavenArtifact for the hpi variant of this artifact.

Throws:

IOException

getDependencyTrail

public List<String> getDependencyTrail()

getGroupId

public String getGroupId()

getScope

public String getScope()

hasScope

public boolean hasScope(String... scopes)

Returns true if the artifacts has one of the given scopes (including null.)

getArtifactId

public String getArtifactId()

Gets the artifactId as used in a dependency declaration. For a plugin artifact this need not be be a plugin short name.

getVersion

public String getVersion()

Gets the version as used in a dependency declaration. For a plugin artifact this need not be be a plugin version number.

getClassifier

public String getClassifier()

getActualArtifactId

public String getActualArtifactId()
                           throws IOException

For a plugin artifact, unlike getArtifactId() this parses the plugin manifest.

Throws:

IOException

getActualVersion

public String getActualVersion()
                        throws IOException

For a plugin artifact, unlike getVersion() this parses the plugin manifest.

Throws:

IOException

getVersionNumber

public org.apache.maven.artifact.versioning.ArtifactVersion getVersionNumber()
                                                                      throws org.apache.maven.artifact.versioning.OverConstrainedVersionException

Throws:

org.apache.maven.artifact.versioning.OverConstrainedVersionException

hasSameGAAs

public boolean hasSameGAAs(org.apache.maven.project.MavenProject project)

Returns true if this artifact has the same groupId and artifactId as the given project.

isNewerThan

public boolean isNewerThan(MavenArtifact rhs)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(MavenArtifact o)

Specified by:

compareTo in interface Comparable<MavenArtifact>