Class EffectiveSiteMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.site.AbstractSiteMojo
-
- org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
- org.apache.maven.plugins.site.descriptor.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 ofsite.xml
, for the first locale.- Since:
- 2.2
-
-
Field Summary
Fields Modifier and Type Field Description 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.descriptor.AbstractSiteDescriptorMojo
reactorProjects, remoteProjectRepositories, repoSession, siteDirectory
-
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
i18n, project, siteTool, skip
-
-
Constructor Summary
Constructors Constructor Description EffectiveSiteMojo()
-
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.plugins.site.descriptor.AbstractSiteDescriptorMojo
prepareSiteModel
-
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getLocales
-
-
-
-
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 nullcomment
- 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
-
-