Package com.azure.tools.codesnippetplugin

Class SnippetBaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.azure.tools.codesnippetplugin.SnippetBaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

UpdateCodesnippet, VerifyCodesnippet

public abstract class SnippetBaseMojo
extends org.apache.maven.plugin.AbstractMojo

Base Mojo for the codesnippet plugin.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CODESNIPPET_GLOB	Default glob to match codesnippet files.
static final String	DEFAULT_README_GLOB	Default glob to match README files.
static final String	DEFAULT_SOURCE_GLOB	Default glob to match source files.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
SnippetBaseMojo()

Method Summary

Modifier and Type	Method	Description
protected void	executeCodesnippet(ExecutionMode executionMode)	Runs codesnippets for the specified ExecutionMode.

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

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

execute

Field Details

DEFAULT_CODESNIPPET_GLOB

public static final String DEFAULT_CODESNIPPET_GLOB

Default glob to match codesnippet files.

See Also:

• Constant Field Values

DEFAULT_SOURCE_GLOB

public static final String DEFAULT_SOURCE_GLOB

Default glob to match source files.

See Also:

• Constant Field Values

DEFAULT_README_GLOB

public static final String DEFAULT_README_GLOB

Default glob to match README files.

See Also:

• Constant Field Values

Constructor Details

SnippetBaseMojo

public SnippetBaseMojo()

Method Details

executeCodesnippet

protected void executeCodesnippet(ExecutionMode executionMode)
                           throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Runs codesnippets for the specified ExecutionMode.

Parameters:

executionMode - The codesnippet execution mode.

Throws:

org.apache.maven.plugin.MojoExecutionException - If codesnippets fails to run successfully.

org.apache.maven.plugin.MojoFailureException - If non-codesnippet exception occurs during processing.