Index
All Classes and Interfaces|All Packages|Constant Field Values
C
- com.azure.tools.codesnippet_maven_plugin - package com.azure.tools.codesnippet_maven_plugin
- com.azure.tools.codesnippetplugin - package com.azure.tools.codesnippetplugin
-
Package containing a Maven codesnippet plugin.
D
- DEFAULT_CODESNIPPET_GLOB - Static variable in class com.azure.tools.codesnippetplugin.SnippetBaseMojo
-
Default glob to match codesnippet files.
- DEFAULT_README_GLOB - Static variable in class com.azure.tools.codesnippetplugin.SnippetBaseMojo
-
Default glob to match README files.
- DEFAULT_SOURCE_GLOB - Static variable in class com.azure.tools.codesnippetplugin.SnippetBaseMojo
-
Default glob to match source files.
E
- execute() - Method in class com.azure.tools.codesnippet_maven_plugin.HelpMojo
- execute() - Method in class com.azure.tools.codesnippetplugin.UpdateCodesnippet
- execute() - Method in class com.azure.tools.codesnippetplugin.VerifyCodesnippet
- executeCodesnippet(ExecutionMode) - Method in class com.azure.tools.codesnippetplugin.SnippetBaseMojo
-
Runs codesnippets for the specified
ExecutionMode. - ExecutionMode - Enum in com.azure.tools.codesnippetplugin
-
Execution modes that the codesnippet plugin supports.
G
- getGlob() - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Gets the glob that determines which files to include.
- getRoot() - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Gets the root directory to begin searching.
- globFiles() - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Gets the list of files that are included based on the root and glob.
H
- HelpMojo - Class in com.azure.tools.codesnippet_maven_plugin
-
Display help information on codesnippet-maven-plugin.
Callmvn codesnippet:help -Ddetail=true -Dgoal=<goal-name>to display parameter details. - HelpMojo() - Constructor for class com.azure.tools.codesnippet_maven_plugin.HelpMojo
R
- RootAndGlob - Class in com.azure.tools.codesnippetplugin
-
Contains a search root and file glob that is used to determine which files to include in processing.
- RootAndGlob() - Constructor for class com.azure.tools.codesnippetplugin.RootAndGlob
-
Creates a new
RootAndGlob. - rootExists() - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Gets whether the root directory exists.
S
- setGlob(String) - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Sets the glob that determines which files to include.
- setRoot(File) - Method in class com.azure.tools.codesnippetplugin.RootAndGlob
-
Sets the root directory to begin searching.
- SnippetBaseMojo - Class in com.azure.tools.codesnippetplugin
-
Base Mojo for the codesnippet plugin.
- SnippetBaseMojo() - Constructor for class com.azure.tools.codesnippetplugin.SnippetBaseMojo
U
- UPDATE - Enum constant in enum com.azure.tools.codesnippetplugin.ExecutionMode
-
Updates the injected codesnippets.
- UpdateCodesnippet - Class in com.azure.tools.codesnippetplugin
-
Mojo for updating codesnippets.
- UpdateCodesnippet() - Constructor for class com.azure.tools.codesnippetplugin.UpdateCodesnippet
V
- valueOf(String) - Static method in enum com.azure.tools.codesnippetplugin.ExecutionMode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.tools.codesnippetplugin.ExecutionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERIFY - Enum constant in enum com.azure.tools.codesnippetplugin.ExecutionMode
-
Verifies the injected codesnippets.
- VerifyCodesnippet - Class in com.azure.tools.codesnippetplugin
-
Mojo for verifying codesnippets.
- VerifyCodesnippet() - Constructor for class com.azure.tools.codesnippetplugin.VerifyCodesnippet
All Classes and Interfaces|All Packages|Constant Field Values