Package org.apache.maven.plugin.idea

Class AbstractIdeaMojo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory  
      protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource  
      protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver  
      protected org.apache.maven.project.MavenProject executedProject
      The Maven Project.
      protected org.apache.maven.artifact.repository.ArtifactRepository localRepo  
      protected org.apache.maven.plugin.logging.Log log  
      protected boolean overwrite
      Whether to update the existing project files or overwrite them.

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) java.lang.String convertDriveLetter​(java.lang.String absolutePath)
      Convert the drive letter, if there is one, to upper case.
      protected org.dom4j.Element createElement​(org.dom4j.Element module, java.lang.String name)
      Creates an Xpp3Dom element.
      private java.util.Map createManagedVersionMap​(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, java.lang.String projectId, org.apache.maven.model.DependencyManagement dependencyManagement)  
      protected void doDependencyResolution​(org.apache.maven.project.MavenProject project, org.apache.maven.artifact.repository.ArtifactRepository localRepo)  
      protected org.dom4j.Element findComponent​(org.dom4j.Element module, java.lang.String name)
      Finds element from the module element.
      protected org.dom4j.Element findElement​(org.dom4j.Element component, java.lang.String name)  
      protected org.dom4j.Element findElement​(org.dom4j.Element element, java.lang.String elementName, java.lang.String attributeName)  
      org.apache.maven.plugin.logging.Log getLog()  
      protected java.lang.String getPluginSetting​(java.lang.String artifactId, java.lang.String optionName, java.lang.String defaultValue)  
      private java.util.Set getProjectArtifacts()  
      void initParam​(org.apache.maven.project.MavenProject project, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, org.apache.maven.artifact.repository.ArtifactRepository localRepo, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.plugin.logging.Log log, boolean overwrite)  
      protected org.dom4j.Document readXmlDocument​(java.io.File file, java.lang.String altFilename)  
      protected void removeOldElements​(org.dom4j.Element content, java.lang.String name)
      Remove elements from content (Xpp3Dom).
      protected java.lang.String toRelative​(java.lang.String basedir, java.lang.String absolutePath)
      Translate the absolutePath into its relative path.
      protected void writeXmlDocument​(java.io.File file, org.dom4j.Document document)  

      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.apache.maven.plugin.Mojo

        execute

    • Field Detail

      • executedProject

        protected org.apache.maven.project.MavenProject executedProject
        The Maven Project.

      • log

        protected org.apache.maven.plugin.logging.Log log

      • overwrite

        protected boolean overwrite
        Whether to update the existing project files or overwrite them.

      • artifactFactory

        protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

      • localRepo

        protected org.apache.maven.artifact.repository.ArtifactRepository localRepo

      • artifactResolver

        protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

      • artifactMetadataSource

        protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

    • Constructor Detail

      • AbstractIdeaMojo

        public AbstractIdeaMojo()

    • Method Detail

      • initParam

        public void initParam​(org.apache.maven.project.MavenProject project,
                      org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepo,
                      org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
                      org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                      org.apache.maven.plugin.logging.Log log,
                      boolean overwrite)

      • readXmlDocument

        protected org.dom4j.Document readXmlDocument​(java.io.File file,
                                             java.lang.String altFilename)
                                      throws org.dom4j.DocumentException
        Throws:
        org.dom4j.DocumentException

      • writeXmlDocument

        protected void writeXmlDocument​(java.io.File file,
                                org.dom4j.Document document)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • findComponent

        protected org.dom4j.Element findComponent​(org.dom4j.Element module,
                                          java.lang.String name)
        Finds element from the module element.
        Parameters:
        module - Xpp3Dom element
        name - Name attribute to find
        Returns:
        component Returns the Xpp3Dom element found.

      • findElement

        protected org.dom4j.Element findElement​(org.dom4j.Element element,
                                        java.lang.String elementName,
                                        java.lang.String attributeName)

      • findElement

        protected org.dom4j.Element findElement​(org.dom4j.Element component,
                                        java.lang.String name)

      • createElement

        protected org.dom4j.Element createElement​(org.dom4j.Element module,
                                          java.lang.String name)
        Creates an Xpp3Dom element.
        Parameters:
        module - Xpp3Dom element
        name - Name of the element
        Returns:
        component Xpp3Dom element

      • toRelative

        protected java.lang.String toRelative​(java.lang.String basedir,
                                      java.lang.String absolutePath)
        Translate the absolutePath into its relative path.
        Parameters:
        basedir - The basedir of the project.
        absolutePath - The absolute path that must be translated to relative path.
        Returns:
        relative Relative path of the parameter absolute path.

      • convertDriveLetter

        java.lang.String convertDriveLetter​(java.lang.String absolutePath)
        Convert the drive letter, if there is one, to upper case. This is done to avoid case mismatch when running cygwin on Windows.
        Parameters:
        absolutePath - The path to convert
        Returns:
        The path that came in with its drive letter converted to upper case

      • removeOldElements

        protected void removeOldElements​(org.dom4j.Element content,
                                 java.lang.String name)
        Remove elements from content (Xpp3Dom).
        Parameters:
        content - Xpp3Dom element
        name - Name of the element to be removed

      • doDependencyResolution

        protected void doDependencyResolution​(org.apache.maven.project.MavenProject project,
                                      org.apache.maven.artifact.repository.ArtifactRepository localRepo)
                               throws org.apache.maven.project.artifact.InvalidDependencyVersionException,
                                      org.apache.maven.project.ProjectBuildingException,
                                      org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
        Throws:
        org.apache.maven.project.artifact.InvalidDependencyVersionException
        org.apache.maven.project.ProjectBuildingException
        org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

      • getPluginSetting

        protected java.lang.String getPluginSetting​(java.lang.String artifactId,
                                            java.lang.String optionName,
                                            java.lang.String defaultValue)

      • getProjectArtifacts

        private java.util.Set getProjectArtifacts()
                                   throws org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
        Throws:
        org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

      • createManagedVersionMap

        private java.util.Map createManagedVersionMap​(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                                              java.lang.String projectId,
                                              org.apache.maven.model.DependencyManagement dependencyManagement)
                                       throws org.apache.maven.project.ProjectBuildingException
        Throws:
        org.apache.maven.project.ProjectBuildingException

      • getLog

        public org.apache.maven.plugin.logging.Log getLog()
        Specified by:
        getLog in interface org.apache.maven.plugin.Mojo
        Overrides:
        getLog in class org.apache.maven.plugin.AbstractMojo