org.apache.maven.plugins.site
Class EffectiveSiteMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugins.site.AbstractSiteMojo
          org.apache.maven.plugins.site.AbstractSiteRenderingMojo
              org.apache.maven.plugins.site.EffectiveSiteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class EffectiveSiteMojo
extends AbstractSiteRenderingMojo

Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of site.xml.

Version:

$Id: EffectiveSiteMojo.java 959796 2010-07-01 22:18:10Z hboutemy $

Author:

Hervé Boutemy

Field Summary

protected java.io.File

output Optional parameter to write the output of this help in a given file, instead of writing to the console.

Fields inherited from class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

artifactFactory, artifactResolver, assembler, attributes, generatedSiteDirectory, mavenReportExecutor, mavenSession, moduleExcludes, plexusContainer, project, repositories, siteRenderer

Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

i18n, locales, localRepository, reactorProjects, reportPlugins, siteDirectory, siteTool

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

ROLE

Constructor Summary

EffectiveSiteMojo()

Method Summary

void	execute()
protected static void	writeComment(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String comment) Write comments in a normalize way.
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.plugins.site.AbstractSiteRenderingMojo

categoriseReports, createSiteRenderingContext, filterReports, getReports, locateDocuments, locateReports

Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

getInputEncoding, getOutputEncoding, populateReportItems, toRelative

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

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

writeXmlFile

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

Throws:

java.io.IOException