Package org.apache.maven.plugins.site.render

Class AutoRefreshMojo

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.render.AbstractSiteRenderingMojo

org.apache.maven.plugins.site.render.AutoRefreshMojo

All Implemented Interfaces:

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

@Mojo(name="auto-refresh",
      requiresDependencyResolution=TEST,
      threadSafe=true,
      aggregator=true)
public class AutoRefreshMojo
extends AbstractSiteRenderingMojo

Renders the site once completely and then watches for Doxia source file changes. After modifications the affected file(s) are re-rendered and the output files updated. The goal blocks until the user presses Enter.

This is intended for use during site development to provide immediate feedback on changes. It only works on a single project and does neither consider child projects nor site staging.

Since:

3.22.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	generateReports	Whether to generate reports during initial rendering.
protected File	outputDirectory	Directory where the project sites and report distributions will be generated (as html/css/...).
private long	pollingInterval	Polling interval in milliseconds for watching file changes.
private final org.codehaus.plexus.components.interactivity.Prompter	prompter

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

alternativeSiteSourceDirectories, generatedSiteDirectory, mavenReportExecutor, mavenSession, mojoExecution, outputTimestamp, siteRenderer

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

Constructor	Description
AutoRefreshMojo(org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assembler, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.reporting.exec.MavenReportExecutor mavenReportExecutor, org.codehaus.plexus.components.interactivity.Prompter prompter)

Method Summary

Modifier and Type	Method	Description
void	execute()
private File	getOutputDirectory(Locale locale)
private void	handleDeletion(File deletedFile, List<Locale> localesList)
private void	renderSite(Locale locale, List<org.apache.maven.reporting.exec.MavenReportExecution> reports, List<Locale> supportedLocales, File outputDirectory)
private void	triggerRerender(File changedFile, List<Locale> localesList)

Methods inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

categoriseReports, checkInputEncoding, createSiteRenderingContext, getInputEncoding, getOutputEncoding, getReports, locateDocuments, locateReports, populateReportItems

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

outputDirectory

@Parameter(property="siteOutputDirectory",
           defaultValue="${project.reporting.outputDirectory}")
protected File outputDirectory

Directory where the project sites and report distributions will be generated (as html/css/...).

pollingInterval

@Parameter(property="auto-refresh.interval",
           defaultValue="1000")
private long pollingInterval

Polling interval in milliseconds for watching file changes.

generateReports

@Parameter(property="generateReports",
           defaultValue="true")
private boolean generateReports

Whether to generate reports during initial rendering.

prompter

private final org.codehaus.plexus.components.interactivity.Prompter prompter

Constructor Details

AutoRefreshMojo

@Inject
public AutoRefreshMojo(org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assembler,
 org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer,
 org.apache.maven.reporting.exec.MavenReportExecutor mavenReportExecutor,
 org.codehaus.plexus.components.interactivity.Prompter prompter)

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

handleDeletion

private void handleDeletion(File deletedFile,
 List<Locale> localesList)

triggerRerender

private void triggerRerender(File changedFile,
 List<Locale> localesList)

renderSite

private void renderSite(Locale locale,
 List<org.apache.maven.reporting.exec.MavenReportExecution> reports,
 List<Locale> supportedLocales,
 File outputDirectory)
                 throws IOException,
org.apache.maven.doxia.siterenderer.RendererException,
org.apache.maven.plugin.MojoFailureException,
org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.doxia.siterenderer.RendererException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getOutputDirectory

private File getOutputDirectory(Locale locale)