org.savantbuild.dep.domain

Class Artifact

java.lang.Object

org.savantbuild.dep.domain.Artifact

Direct Known Subclasses:

ReifiedArtifact

public class Artifact
extends java.lang.Object

This class defines an artifact as it exists across all projects, dependencies, etc. This class is the representation of the artifact that is defined by its group, project, name, type and version. This object is also the representation of a dependency between two project's.

See the Artifact(String, boolean) constructor for String formats of artifacts.

Field Summary

Fields

Modifier and Type	Field and Description
ArtifactID	id
boolean	skipCompatibilityCheck
Version	version

Constructor Summary

Constructors

Constructor and Description
Artifact(ArtifactID id, Version version, boolean skipCompatibilityCheck) Constructs an Artifact with the given ID and version.
Artifact(java.lang.String spec, boolean skipCompatibilityCheck) Parses the given specification to build an artifact.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getArtifactFile() Returns the artifact file name.
java.lang.String	getArtifactMetaDataFile() Returns the artifact MetaData file name.
java.lang.String	getArtifactSourceFile() Returns the artifact source file name.
java.lang.String	getArtifactTestFile() Returns the artifact test file name.
java.lang.String	getArtifactTestSourceFile() Returns the artifact test source file name.
int	hashCode()
boolean	isIntegrationBuild()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

public final ArtifactID id

skipCompatibilityCheck

public final boolean skipCompatibilityCheck

version

public final Version version

Constructor Detail

Artifact

public Artifact(ArtifactID id,
                Version version,
                boolean skipCompatibilityCheck)

Constructs an Artifact with the given ID and version.

Parameters:

id - The artifact ID (group, project, name, type).

version - The version of the artifact.

skipCompatibilityCheck - Determines if the compatibility check is skipped for this artifact or not.

Artifact

public Artifact(java.lang.String spec,
                boolean skipCompatibilityCheck)

Parses the given specification to build an artifact. The currently supported spec formats are:

   group:project:version
   group:project:version:type
   group:project:name:version:type
 

Examples:

   org.savantbuild.dep:savant-dependency-management:0.1
   org.savantbuild.dep:savant-dependency-management:0.1:jar
   org.savantbuild.dep:savant-dependency-management:some-other-artifact:0.1:jar
 

Parameters:

spec - The spec.

skipCompatibilityCheck - Determines if the compatibility check is skipped for this artifact or not.

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getArtifactFile

public java.lang.String getArtifactFile()

Returns the artifact file name. This does not include any path information at all and would look something like this:

 common-collections-2.1.jar
 

Returns:

The file name.

getArtifactMetaDataFile

public java.lang.String getArtifactMetaDataFile()

Returns the artifact MetaData file name. This does not include any path information at all and would look something like this:

 common-collections-2.1.jar.amd
 

Returns:

The MetaData file name.

getArtifactSourceFile

public java.lang.String getArtifactSourceFile()

Returns the artifact source file name. This does not include any path information at all and would look something like this:

 common-collections-2.1-src.jar
 

Returns:

The source file name.

getArtifactTestFile

public java.lang.String getArtifactTestFile()

Returns the artifact test file name. This does not include any path information at all and would look something like this:

 common-collections-test-2.1.jar
 

Returns:

The file name.

getArtifactTestSourceFile

public java.lang.String getArtifactTestSourceFile()

Returns the artifact test source file name. This does not include any path information at all and would look something like this:

 common-collections-test-2.1.jar
 

Returns:

The file name.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isIntegrationBuild

public boolean isIntegrationBuild()

Returns:

Whether or not the version of this artifact is an integration build version.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object