EffectiveSiteMojo (Apache Maven Site Plugin 3.9.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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:

ContextEnabled, 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

Author:

Hervé Boutemy

Field Summary

Fields
Modifier and Type Field and Description

protected 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
  repositories, siteDirectory
- Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
  i18n, localRepository, project, reactorProjects, siteTool, skip
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor and Description

EffectiveSiteMojo()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute()`
`protected static void`	`writeComment(XMLWriter writer, String comment)` Write comments in a normalize way.
`protected static void`	`writeHeader(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
prepareDecorationModel

Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getLocales, getMavenVersion, isMaven3OrMore

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 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 MojoExecutionException,
                    MojoFailureException

Throws:: MojoExecutionException; MojoFailureException

writeHeader
```
protected static void writeHeader(XMLWriter writer)
```
Write comments in the Effective POM/settings header.

Parameters:
writer - not null

writeComment

protected static void writeComment(XMLWriter writer,
                String comment)

Write comments in a normalize way.

Parameters:: writer - not null; comment - not null

writeXmlFile

protected static void writeXmlFile(File output,
                String content)
                            throws IOException

Throws:: IOException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2020 The Apache Software Foundation. All rights reserved.