org.jenkinsci.maven.plugins.hpi

Class MavenArtifact

java.lang.Object

org.jenkinsci.maven.plugins.hpi.MavenArtifact

public class MavenArtifact
extends Object

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.MavenProjectBuilder	builder
org.apache.maven.artifact.repository.ArtifactRepository	localRepository
List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories
org.apache.maven.artifact.resolver.ArtifactResolver	resolver

Constructor Summary

Constructors

Constructor and Description
MavenArtifact(org.apache.maven.artifact.Artifact artifact, org.apache.maven.artifact.resolver.ArtifactResolver resolver, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, org.apache.maven.project.MavenProjectBuilder builder, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories, org.apache.maven.artifact.repository.ArtifactRepository localRepository)

Method Summary

Methods

Modifier and Type	Method and Description
String	getArtifactId()
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()
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?
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.MavenProjectBuilder builder

remoteRepositories

public final List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

localRepository

public final org.apache.maven.artifact.repository.ArtifactRepository localRepository

artifact

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

resolver

public final org.apache.maven.artifact.resolver.ArtifactResolver resolver

Constructor Detail

MavenArtifact

public MavenArtifact(org.apache.maven.artifact.Artifact artifact,
             org.apache.maven.artifact.resolver.ArtifactResolver resolver,
             org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
             org.apache.maven.project.MavenProjectBuilder builder,
             List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories,
             org.apache.maven.artifact.repository.ArtifactRepository localRepository)

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

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()

Returns MavenArtifact for the hpi variant of this artifact.

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()

getVersion

public String getVersion()

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