Field Detail

• project

  @Parameter(property="project",
             required=true,
             readonly=true)
  protected MavenProject project

  The project whose project files to create.

• executedProject

  @Parameter(property="executedProject",
             readonly=true)
  protected MavenProject executedProject

  The currently executed project (can be a reactor project).

• packaging

  @Parameter(property="project.packaging")
  protected String packaging

  The project packaging.

• artifactFactory

  @Component(role=org.apache.maven.artifact.factory.ArtifactFactory.class)
  protected ArtifactFactory artifactFactory

  Artifact factory, needed to download source jars for inclusion in classpath.

• artifactResolver

  @Component(role=org.apache.maven.artifact.resolver.ArtifactResolver.class)
  protected ArtifactResolver artifactResolver

  Artifact resolver, needed to download source jars for inclusion in classpath.

• artifactCollector

  @Component(role=org.apache.maven.artifact.resolver.ArtifactCollector.class)
  protected ArtifactCollector artifactCollector

  Artifact collector, needed to resolve dependencies.

• artifactMetadataSource

  @Component(role=org.apache.maven.artifact.metadata.ArtifactMetadataSource.class,
             hint="maven")
  protected ArtifactMetadataSource artifactMetadataSource

• remoteArtifactRepositories

  @Parameter(property="project.remoteArtifactRepositories",
             required=true,
             readonly=true)
  protected List remoteArtifactRepositories

  Remote repositories which will be searched for source attachments.

• localRepository

  @Parameter(property="localRepository",
             required=true,
             readonly=true)
  protected ArtifactRepository localRepository

  Local maven repository.

• reactorProjects

  @Parameter(property="reactorProjects",
             required=true,
             readonly=true)
  protected List reactorProjects

  If the executed project is a reactor project, this will contains the full list of projects in the reactor.

• downloadSources

  @Parameter(property="downloadSources")
  protected boolean downloadSources

  Enables/disables the downloading of source attachments. Defaults to false. When this flag is true remote repositories are checked for sources: in order to avoid repeated check for unavailable source archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.

• downloadJavadocs

  @Parameter(property="downloadJavadocs")
  protected boolean downloadJavadocs

  Enables/disables the downloading of javadoc attachments. Defaults to false. When this flag is true remote repositories are checked for javadocs: in order to avoid repeated check for unavailable javadoc archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.

• forceRecheck

  @Parameter(property="forceRecheck")
  protected boolean forceRecheck

  Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments. Defaults to false. When this flag is true and the source or javadoc attachment has a status cache to indicate that it is not available, then the remote repository will be rechecked for a source or javadoc attachment and the status cache updated to reflect the new state.

• logger

  protected org.codehaus.plexus.logging.Logger logger

  Plexus logger needed for debugging manual artifact resolution.

Constructor Detail

• AbstractIdeSupportMojo

  public AbstractIdeSupportMojo()

Method Detail

• getArtifactMetadataSource

  public ArtifactMetadataSource getArtifactMetadataSource()

  Getter for artifactMetadataSource.

  Returns:

  Returns the artifactMetadataSource.

• setArtifactMetadataSource

  public void setArtifactMetadataSource(ArtifactMetadataSource artifactMetadataSource)

  Setter for artifactMetadataSource.

  Parameters:

  artifactMetadataSource - The artifactMetadataSource to set.

• getProject

  public MavenProject getProject()

  Getter for project.

  Returns:

  Returns the project.

• setProject

  public void setProject(MavenProject project)

  Setter for project.

  Parameters:

  project - The project to set.

• getReactorProjects

  public List getReactorProjects()

  Getter for reactorProjects.

  Returns:

  Returns the reactorProjects.

• setReactorProjects

  public void setReactorProjects(List reactorProjects)

  Setter for reactorProjects.

  Parameters:

  reactorProjects - The reactorProjects to set.

• getRemoteArtifactRepositories

  public List getRemoteArtifactRepositories()

  Getter for remoteArtifactRepositories.

  Returns:

  Returns the remoteArtifactRepositories.

• setRemoteArtifactRepositories

  public void setRemoteArtifactRepositories(List remoteArtifactRepositories)

  Setter for remoteArtifactRepositories.

  Parameters:

  remoteArtifactRepositories - The remoteArtifactRepositories to set.

• getArtifactFactory

  public ArtifactFactory getArtifactFactory()

  Getter for artifactFactory.

  Returns:

  Returns the artifactFactory.

• setArtifactFactory

  public void setArtifactFactory(ArtifactFactory artifactFactory)

  Setter for artifactFactory.

  Parameters:

  artifactFactory - The artifactFactory to set.

• getArtifactResolver

  public ArtifactResolver getArtifactResolver()

  Getter for artifactResolver.

  Returns:

  Returns the artifactResolver.

• setArtifactResolver

  public void setArtifactResolver(ArtifactResolver artifactResolver)

  Setter for artifactResolver.

  Parameters:

  artifactResolver - The artifactResolver to set.

• getExecutedProject

  public MavenProject getExecutedProject()

  Getter for executedProject.

  Returns:

  Returns the executedProject.

• setExecutedProject

  public void setExecutedProject(MavenProject executedProject)

  Setter for executedProject.

  Parameters:

  executedProject - The executedProject to set.

• getLocalRepository

  public ArtifactRepository getLocalRepository()

  Getter for localRepository.

  Returns:

  Returns the localRepository.

• setLocalRepository

  public void setLocalRepository(ArtifactRepository localRepository)

  Setter for localRepository.

  Parameters:

  localRepository - The localRepository to set.

• getDownloadJavadocs

  public boolean getDownloadJavadocs()

  Getter for downloadJavadocs.

  Returns:

  Returns the downloadJavadocs.

• setDownloadJavadocs

  public void setDownloadJavadocs(boolean downloadJavadoc)

  Setter for downloadJavadocs.

  Parameters:

  downloadJavadoc - The downloadJavadocs to set.

• getDownloadSources

  public boolean getDownloadSources()

  Getter for downloadSources.

  Returns:

  Returns the downloadSources.

• setDownloadSources

  public void setDownloadSources(boolean downloadSources)

  Setter for downloadSources.

  Parameters:

  downloadSources - The downloadSources to set.

• setResolveDependencies

  protected void setResolveDependencies(boolean resolveDependencies)

• isResolveDependencies

  protected boolean isResolveDependencies()

• getUseProjectReferences

  protected abstract boolean getUseProjectReferences()

  return false if projects available in a reactor build should be considered normal dependencies, true if referenced project will be linked and not need artifact resolution.

  Returns:

  true if referenced project will be linked and not need artifact resolution

• setup

  protected abstract boolean setup()
                            throws MojoExecutionException

  Hook for preparation steps before the actual plugin execution.

  Returns:

  true if execution should continue or false if not.

  Throws:

  MojoExecutionException - generic mojo exception

• writeConfiguration

  protected abstract void writeConfiguration(IdeDependency[] deps)
                                      throws MojoExecutionException

  Main plugin method where dependencies should be processed in order to generate IDE configuration files.

  Parameters:

  deps - list of IdeDependency objects, with artifacts, sources and javadocs already resolved

  Throws:

  MojoExecutionException - generic mojo exception

• enableLogging

  public void enableLogging(org.codehaus.plexus.logging.Logger logger)

  Specified by:

  enableLogging in interface org.codehaus.plexus.logging.LogEnabled

  See Also:

  LogEnabled.enableLogging(org.codehaus.plexus.logging.Logger)

• execute

  public final void execute()
                     throws MojoExecutionException,
                            MojoFailureException

  Specified by:

  execute in interface Mojo

  Throws:

  MojoExecutionException

  MojoFailureException

  See Also:

  Mojo.execute()

• doDependencyResolution

  protected IdeDependency[] doDependencyResolution()
                                            throws MojoExecutionException

  Resolve project dependencies. Manual resolution is needed in order to avoid resolution of multiproject artifacts (if projects will be linked each other an installed jar is not needed) and to avoid a failure when a jar is missing.

  Returns:

  resolved IDE dependencies, with attached jars for non-reactor dependencies

  Throws:

  MojoExecutionException - if dependencies can't be resolved

• getProjectNameForArifact

  public abstract String getProjectNameForArifact(Artifact artifact)

  Find the name of the project as used in eclipse.

  Parameters:

  artifact - The artifact to find the eclipse name for.

  Returns:

  The name os the eclipse project.

• isAvailableAsAReactorProject

  protected boolean isAvailableAsAReactorProject(Artifact artifact)

  Utility method that locates a project producing the given artifact.

  Parameters:

  artifact - the artifact a project should produce.

  Returns:

  true if the artifact is produced by a reactor projectart.

• getReactorProject

  protected MavenProject getReactorProject(Artifact artifact)

  Checks the list of reactor projects to see if the artifact is included.

  Parameters:

  artifact - the artifact to check if it is in the reactor

  Returns:

  the reactor project or null if it is not in the reactor

• getWorkspaceArtefacts

  protected IdeDependency[] getWorkspaceArtefacts()

  Returns:

  an array with all dependencies available in the workspace, to be implemented by the subclasses.

• getExcludes

  public abstract List getExcludes()

  Returns:

  List of dependencies to exclude from eclipse classpath.

  Since:

  2.5

• hasToResolveJar

  protected boolean hasToResolveJar(Artifact art)

  Checks if jar has to be resolved for the given artifact

  Parameters:

  art - the artifact to check

  Returns:

  true if resolution should happen

• useProjectReference

  protected boolean useProjectReference(Artifact art)

  Checks if a projects reference has to be used for the given artifact

  Parameters:

  art - the artifact to check

  Returns:

  true if a project reference has to be used.

• isMavenVersion

  protected boolean isMavenVersion(String version)

  Checks whether the currently running Maven satisfies the specified version (range).

  Parameters:

  version - The version range to test for, must not be null.

  Returns:

  true if the current Maven version matches the specified version range, false otherwise.