Class EffectiveSiteMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="effective-site",
          requiresReports=true)
    public class EffectiveSiteMojo
    extends AbstractSiteDescriptorMojo
    Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of site.xml, for the first locale.
    Since:
    2.2
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()
      protected static void writeComment​(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String comment)
      Write comments in a normalize way.
      private void writeEffectiveSite​(org.apache.maven.doxia.site.SiteModel siteModel, org.codehaus.plexus.util.xml.XMLWriter writer)  
      protected static void writeHeader​(org.codehaus.plexus.util.xml.XMLWriter writer)
      Write comments in the Effective POM/settings header.
      protected static void writeXmlFile​(java.io.File output, java.lang.String content)  
      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getLog, getPluginContext, setLog, setPluginContext
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • output

        @Parameter(property="output")
        protected java.io.File output
        Optional parameter to write the output of this help in a given file, instead of writing to the console.

        Note: Could be a relative path.

    • Constructor Detail

      • EffectiveSiteMojo

        public EffectiveSiteMojo()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
      • writeHeader

        protected static void writeHeader​(org.codehaus.plexus.util.xml.XMLWriter writer)
        Write comments in the Effective POM/settings header.
        Parameters:
        writer - not null
      • writeComment

        protected static void writeComment​(org.codehaus.plexus.util.xml.XMLWriter writer,
                                           java.lang.String comment)
        Write comments in a normalize way.
        Parameters:
        writer - not null
        comment - not null
      • writeEffectiveSite

        private void writeEffectiveSite​(org.apache.maven.doxia.site.SiteModel siteModel,
                                        org.codehaus.plexus.util.xml.XMLWriter writer)
                                 throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
      • writeXmlFile

        protected static void writeXmlFile​(java.io.File output,
                                           java.lang.String content)
                                    throws java.io.IOException
        Throws:
        java.io.IOException