IdeDependency (Apache Maven Eclipse Plugin (RETIRED) 2.10 API)

java.lang.Object
- org.apache.maven.plugin.ide.IdeDependency

All Implemented Interfaces:

Comparable
```
public class IdeDependency
extends Object
implements Comparable
```
Version:

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

Author:

Fabrizio Giustina

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object o)`
`boolean`	`equals(Object obj)`
`String`	`getArtifactId()` Getter for `artifactId`.
`String`	`getClassifier()` Getter for `classifier`.
`String`	`getEclipseProjectName()` Getter for `eclipseProjectName`.
`File`	`getFile()` Getter for `file`.
`String`	`getGroupId()` Getter for `groupId`.
`String`	`getId()` Getter for `artifactId`.
`File`	`getJavadocAttachment()` Getter for `javadocAttachment`.
`File`	`getSourceAttachment()` Getter for `sourceAttachment`.
`String`	`getType()` Getter for `type`.
`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(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(String artifactId)` Setter for `artifactId`.
`void`	`setClassifier(String classifier)` Setter for `groupId`.
`void`	`setEclipseProjectName(String eclipseProjectName)` Setter for `eclipseProjectName`.
`void`	`setFile(File file)` Setter for `file`.
`void`	`setGroupId(String groupId)` Setter for `groupId`.
`void`	`setJavadocAttachment(File javadocAttachment)` Setter for `javadocAttachment`.
`void`	`setProvided(boolean provided)` Setter for `provided`.
`void`	`setReferencedProject(boolean referencedProject)` Setter for `referencedProject`.
`void`	`setSourceAttachment(File sourceAttachment)` Setter for `sourceAttachment`.
`void`	`setSystemScoped(boolean systemScoped)` Setter for `systemScoped`.
`void`	`setTestDependency(boolean testDependency)` Setter for `testDependency`.
`void`	`setType(String type)` Setter for `type`.
`void`	`setVersion(String version)` Setter for `version`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IdeDependency
```
public IdeDependency()
```
    Creates an uninitialized instance
  - IdeDependency
```
public IdeDependency(String groupId,
             String artifactId,
             String version,
             String classifier,
             boolean referencedProject,
             boolean testDependency,
             boolean systemScoped,
             boolean provided,
             boolean addedToClasspath,
             File file,
             String type,
             boolean osgiBundle,
             String osgiSymbolicName,
             int dependencyDepth,
             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 File getJavadocAttachment()
```
    Getter for javadocAttachment.
    
    Returns:
    Returns the javadocAttachment.
  - setJavadocAttachment
```
public void setJavadocAttachment(File javadocAttachment)
```
    Setter for javadocAttachment.
    
    Parameters:
    javadocAttachment - The javadocAttachment to set.
  - getArtifactId
```
public String getArtifactId()
```
    Getter for artifactId.
    
    Returns:
    Returns the artifactId.
  - setArtifactId
```
public void setArtifactId(String artifactId)
```
    Setter for artifactId.
    
    Parameters:
    artifactId - The artifactId to set.
  - getGroupId
```
public String getGroupId()
```
    Getter for groupId.
    
    Returns:
    Returns the groupId.
  - setGroupId
```
public void setGroupId(String groupId)
```
    Setter for groupId.
    
    Parameters:
    groupId - The groupId to set.
  - getVersion
```
public String getVersion()
```
    Getter for version.
    
    Returns:
    Returns the version.
  - setVersion
```
public void setVersion(String version)
```
    Setter for version.
    
    Parameters:
    version - The version to set.
  - getClassifier
```
public String getClassifier()
```
    Getter for classifier.
    
    Returns:
    Returns the classifier.
  - setClassifier
```
public void setClassifier(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 File getSourceAttachment()
```
    Getter for sourceAttachment.
    
    Returns:
    Returns the sourceAttachment.
  - setSourceAttachment
```
public void setSourceAttachment(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 File getFile()
```
    Getter for file.
    
    Returns:
    Returns the file.
  - setFile
```
public void setFile(File file)
```
    Setter for file.
    
    Parameters:
    file - The file to set.
  - getId
```
public String getId()
```
    Getter for artifactId.
    
    Returns:
    Returns the artifactId.
  - getType
```
public String getType()
```
    Getter for type.
    
    Returns:
    Returns the type.
  - setType
```
public void setType(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 String getEclipseProjectName()
```
    Getter for eclipseProjectName.
    
    Returns:
    Returns the eclipseProjectName.
  - setEclipseProjectName
```
public void setEclipseProjectName(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 String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    Object.toString()
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable
    
    See Also:
    Compare using groupId+artifactId+type+classifier Strings
  - isSystemScopedOutsideProject
```
public boolean isSystemScopedOutsideProject(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(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class IdeDependency

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdeDependency

IdeDependency

Method Detail

getJavadocAttachment

setJavadocAttachment

getArtifactId

setArtifactId

getGroupId

setGroupId

getVersion

setVersion

getClassifier

setClassifier

isReferencedProject

isOsgiBundle

setReferencedProject

getSourceAttachment

setSourceAttachment

isSystemScoped

setSystemScoped

isTestDependency

setTestDependency

getFile

setFile

getId

getType

setType

isAddedToClasspath

setAddedToClasspath

isProvided

setProvided

getEclipseProjectName

setEclipseProjectName

isAjdtWeaveDependency

setAjdtWeaveDependency

isAjdtDependency

setAjdtDependency

toString

compareTo

isSystemScopedOutsideProject

isJavaApi

equals

hashCode