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 of
site.xml
, for the first locale.- Since:
- 2.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected File
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
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
protected static void
writeComment
(org.codehaus.plexus.util.xml.XMLWriter writer, 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
(File output, 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
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
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 Details
-
EffectiveSiteMojo
public EffectiveSiteMojo()
-
-
Method Details
-
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
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
- Throws:
IOException
-