org.wildfly.maven.plugins.quickstart.documentation

Class TOCMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.wildfly.maven.plugins.quickstart.documentation.TOCMojo

All Implemented Interfaces:

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

@Mojo(name="table-of-contents",
      threadSafe=true,
      defaultPhase=PROCESS_RESOURCES)
public class TOCMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Tomaz Cerar (c) 2017 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.project.MavenProject	project The project
protected String	replaceMarker
protected String	targetDocument

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

ROLE

Constructor Summary

Constructors

Constructor and Description
TOCMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

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

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

The project

replaceMarker

@Parameter(defaultValue="[TOC-quickstart]",
           required=true)
protected String replaceMarker

targetDocument

@Parameter(defaultValue="target/docs/README.md",
           required=true)
protected String targetDocument

Constructor Detail

TOCMojo

public TOCMojo()

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