org.apache.maven.plugin.ide

Class IdeDependency

java.lang.Object

org.apache.maven.plugin.ide.IdeDependency

All Implemented Interfaces:

java.lang.Comparable

public class IdeDependency
extends java.lang.Object
implements java.lang.Comparable

Version:

$Id: IdeDependency.java 691404 2008-09-02 21:57:19Z aheritier $

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	addedToClasspath Is this dependency added to classpath?
private boolean	ajdtDependency The ajdt dependency.
private boolean	ajdtWeaveDependency The ajdt weave dependency
private java.lang.String	artifactId Artifact id.
private java.lang.String	classifier Artifact classifier
private java.lang.String	eclipseProjectName How is this dependency called when it is an eclipse project.
private java.io.File	file Resolved artifact file.
private java.lang.String	groupId Group id.
private java.io.File	javadocAttachment Resolved javadoc file.
private boolean	osgiBundle Does this artifact contains a OSGI Manifest?
private boolean	provided Is this a provided dependency?
private boolean	referencedProject Is this dependency available in the reactor?
private java.io.File	sourceAttachment Resolved source file.
private boolean	systemScoped Is this a system scope dependency?
private boolean	testDependency Is this a test dependency?
private java.lang.String	type Artifact type.
private java.lang.String	version Artifact version.

Constructor Summary

Constructors

Constructor and Description
IdeDependency() Creates an uninitialized instance
IdeDependency(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String classifier, boolean referencedProject, boolean testDependency, boolean systemScoped, boolean provided, boolean addedToClasspath, java.io.File file, java.lang.String type, boolean osgiBundle, java.lang.String osgiSymbolicName, int dependencyDepth, java.lang.String eclipseProjectName)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object obj)
java.lang.String	getArtifactId() Getter for artifactId.
java.lang.String	getClassifier() Getter for classifier.
java.lang.String	getEclipseProjectName() Getter for eclipseProjectName.
java.io.File	getFile() Getter for file.
java.lang.String	getGroupId() Getter for groupId.
java.lang.String	getId() Getter for artifactId.
java.io.File	getJavadocAttachment() Getter for javadocAttachment.
java.io.File	getSourceAttachment() Getter for sourceAttachment.
java.lang.String	getType() Getter for type.
java.lang.String	getVersion() Getter for version.
int	hashCode()
boolean	isAddedToClasspath() Getter for addedToClasspath.
boolean	isAjdtDependency() Returns the ajdtDependency.
boolean	isAjdtWeaveDependency() Returns the ajdtWeaveDependency.
boolean	isJavaApi()
boolean	isOsgiBundle() Getter for osgiBundle.
boolean	isProvided() Getter for provided.
boolean	isReferencedProject() Getter for referencedProject.
boolean	isSystemScoped() Getter for systemScoped.
boolean	isSystemScopedOutsideProject(org.apache.maven.project.MavenProject project) Is this dependency System scoped outside the eclipse project.
boolean	isTestDependency() Getter for testDependency.
void	setAddedToClasspath(boolean addedToClasspath) Setter for addedToClasspath.
void	setAjdtDependency(boolean ajdtDependency) Sets the ajdtDependency.
void	setAjdtWeaveDependency(boolean ajdtWeaveDependency) Sets the ajdtWeaveDependency.
void	setArtifactId(java.lang.String artifactId) Setter for artifactId.
void	setClassifier(java.lang.String classifier) Setter for groupId.
void	setEclipseProjectName(java.lang.String eclipseProjectName) Setter for eclipseProjectName.
void	setFile(java.io.File file) Setter for file.
void	setGroupId(java.lang.String groupId) Setter for groupId.
void	setJavadocAttachment(java.io.File javadocAttachment) Setter for javadocAttachment.
void	setProvided(boolean provided) Setter for provided.
void	setReferencedProject(boolean referencedProject) Setter for referencedProject.
void	setSourceAttachment(java.io.File sourceAttachment) Setter for sourceAttachment.
void	setSystemScoped(boolean systemScoped) Setter for systemScoped.
void	setTestDependency(boolean testDependency) Setter for testDependency.
void	setType(java.lang.String type) Setter for type.
void	setVersion(java.lang.String version) Setter for version.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

referencedProject

private boolean referencedProject

Is this dependency available in the reactor?

testDependency

private boolean testDependency

Is this a test dependency?

systemScoped

private boolean systemScoped

Is this a system scope dependency?

provided

private boolean provided

Is this a provided dependency?

addedToClasspath

private boolean addedToClasspath

Is this dependency added to classpath?

file

private java.io.File file

Resolved artifact file.

javadocAttachment

private java.io.File javadocAttachment

Resolved javadoc file.

sourceAttachment

private java.io.File sourceAttachment

Resolved source file.

groupId

private java.lang.String groupId

Group id.

artifactId

private java.lang.String artifactId

Artifact id.

version

private java.lang.String version

Artifact version.

classifier

private java.lang.String classifier

Artifact classifier

type

private java.lang.String type

Artifact type.

osgiBundle

private boolean osgiBundle

Does this artifact contains a OSGI Manifest?

eclipseProjectName

private java.lang.String eclipseProjectName

How is this dependency called when it is an eclipse project.

ajdtWeaveDependency

private boolean ajdtWeaveDependency

The ajdt weave dependency

ajdtDependency

private boolean ajdtDependency

The ajdt dependency.

Constructor Detail

IdeDependency

public IdeDependency()

Creates an uninitialized instance

IdeDependency

public IdeDependency(java.lang.String groupId,
                     java.lang.String artifactId,
                     java.lang.String version,
                     java.lang.String classifier,
                     boolean referencedProject,
                     boolean testDependency,
                     boolean systemScoped,
                     boolean provided,
                     boolean addedToClasspath,
                     java.io.File file,
                     java.lang.String type,
                     boolean osgiBundle,
                     java.lang.String osgiSymbolicName,
                     int dependencyDepth,
                     java.lang.String eclipseProjectName)

Parameters:

groupId - Group id

artifactId - Artifact id

version - Artifact version

classifier - Artifact classifier

referencedProject - Is this dependency available in the reactor?

testDependency - Is this a test dependency?

systemScoped - Is this a system scope dependency?

provided - Is this a provided dependency?

addedToClasspath - Is this dependency added to classpath?

file - Resolved artifact file

type - Artifact type

osgiBundle - Does this artifact contains a OSGI Manifest?

osgiSymbolicName - Bundle-SymbolicName from the Manifest (if available)

dependencyDepth - Depth of this dependency in the transitive dependency trail.

eclipseProjectName - The name of the project in eclipse

Method Detail

getJavadocAttachment

public java.io.File getJavadocAttachment()

Getter for javadocAttachment.

Returns:

Returns the javadocAttachment.

setJavadocAttachment

public void setJavadocAttachment(java.io.File javadocAttachment)

Setter for javadocAttachment.

Parameters:

javadocAttachment - The javadocAttachment to set.

getArtifactId

public java.lang.String getArtifactId()

Getter for artifactId.

Returns:

Returns the artifactId.

setArtifactId

public void setArtifactId(java.lang.String artifactId)

Setter for artifactId.

Parameters:

artifactId - The artifactId to set.

getGroupId

public java.lang.String getGroupId()

Getter for groupId.

Returns:

Returns the groupId.

setGroupId

public void setGroupId(java.lang.String groupId)

Setter for groupId.

Parameters:

groupId - The groupId to set.

getVersion

public java.lang.String getVersion()

Getter for version.

Returns:

Returns the version.

setVersion

public void setVersion(java.lang.String version)

Setter for version.

Parameters:

version - The version to set.

getClassifier

public java.lang.String getClassifier()

Getter for classifier.

Returns:

Returns the classifier.

setClassifier

public void setClassifier(java.lang.String classifier)

Setter for groupId.

Parameters:

groupId - The groupId to set.

isReferencedProject

public boolean isReferencedProject()

Getter for referencedProject.

Returns:

Returns the referencedProject.

isOsgiBundle

public boolean isOsgiBundle()

Getter for osgiBundle.

Returns:

Returns the osgiBundle.

setReferencedProject

public void setReferencedProject(boolean referencedProject)

Setter for referencedProject.

Parameters:

referencedProject - The referencedProject to set.

getSourceAttachment

public java.io.File getSourceAttachment()

Getter for sourceAttachment.

Returns:

Returns the sourceAttachment.

setSourceAttachment

public void setSourceAttachment(java.io.File sourceAttachment)

Setter for sourceAttachment.

Parameters:

sourceAttachment - The sourceAttachment to set.

isSystemScoped

public boolean isSystemScoped()

Getter for systemScoped.

Returns:

Returns the systemScoped.

setSystemScoped

public void setSystemScoped(boolean systemScoped)

Setter for systemScoped.

Parameters:

systemScoped - The systemScoped to set.

isTestDependency

public boolean isTestDependency()

Getter for testDependency.

Returns:

Returns the testDependency.

setTestDependency

public void setTestDependency(boolean testDependency)

Setter for testDependency.

Parameters:

testDependency - The testDependency to set.

getFile

public java.io.File getFile()

Getter for file.

Returns:

Returns the file.

setFile

public void setFile(java.io.File file)

Setter for file.

Parameters:

file - The file to set.

getId

public java.lang.String getId()

Getter for artifactId.

Returns:

Returns the artifactId.

getType

public java.lang.String getType()

Getter for type.

Returns:

Returns the type.

setType

public void setType(java.lang.String type)

Setter for type.

Parameters:

type - The type to set.

isAddedToClasspath

public boolean isAddedToClasspath()

Getter for addedToClasspath.

Returns:

Returns the addedToClasspath.

setAddedToClasspath

public void setAddedToClasspath(boolean addedToClasspath)

Setter for addedToClasspath.

Parameters:

addedToClasspath - The addedToClasspath to set.

isProvided

public boolean isProvided()

Getter for provided.

Returns:

Returns the provided.

setProvided

public void setProvided(boolean provided)

Setter for provided.

Parameters:

provided - The provided to set.

getEclipseProjectName

public java.lang.String getEclipseProjectName()

Getter for eclipseProjectName.

Returns:

Returns the eclipseProjectName.

setEclipseProjectName

public void setEclipseProjectName(java.lang.String eclipseProjectName)

Setter for eclipseProjectName.

Parameters:

eclipseProjectName - The eclipseProjectName to set.

isAjdtWeaveDependency

public boolean isAjdtWeaveDependency()

Returns the ajdtWeaveDependency.

Returns:

the ajdtWeaveDependency.

setAjdtWeaveDependency

public void setAjdtWeaveDependency(boolean ajdtWeaveDependency)

Sets the ajdtWeaveDependency.

Parameters:

ajdtWeaveDependency - the ajdtWeaveDependency.

isAjdtDependency

public boolean isAjdtDependency()

Returns the ajdtDependency.

Returns:

the ajdtDependency.

setAjdtDependency

public void setAjdtDependency(boolean ajdtDependency)

Sets the ajdtDependency.

Parameters:

ajdtDependency - the ajdtDependency.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Compare using groupId+artifactId+type+classifier Strings

isSystemScopedOutsideProject

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

Is this dependency System scoped outside the eclipse project. This is NOT complete because in reality the check should mean that any module in the reactor contains the system scope locally!

Returns:

Returns this dependency is systemScoped outside the project.

isJavaApi

public boolean isJavaApi()

Returns:

true if this dependency is a Java API

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object