Index (Maven Plugin Tools 3.4 API)

A B C D E F G H I J L M N O P R S T U V W
A

AbstractGeneratorMojo - Class in org.apache.maven.plugin.plugin: Abstract class for this Plugin.
AbstractGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
AbstractMojoFieldTaglet - Class in org.apache.maven.tools.plugin.javadoc: Abstract Taglet for annotations specified at the Mojo parameter level.
AbstractMojoFieldTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
AbstractMojoTaglet - Class in org.apache.maven.tools.plugin.javadoc: Abstract Taglet for Maven Mojo annotations.
AbstractMojoTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
AbstractMojoTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc: Abstract Taglet for annotations specified at the Mojo class level.
AbstractMojoTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
AbstractScriptedMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor
AbstractScriptedMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
addComponent(Component) - Method in class org.apache.maven.plugin.tools.model.Mojo: Method addComponent.
addComponentRequirement(ComponentRequirement, Object) - Method in class org.apache.maven.script.ant.AntMojoWrapper
addMojo(Mojo) - Method in class org.apache.maven.plugin.tools.model.PluginMetadata: Method addMojo.
addOther(String, String) - Method in class org.apache.maven.plugin.plugin.Requirements: Method addOther.
addParameter(Parameter) - Method in class org.apache.maven.plugin.tools.model.Mojo: Method addParameter.
AddPluginArtifactMetadataMojo - Class in org.apache.maven.plugin.plugin.metadata: Inject any plugin-specific artifact metadata to the project's artifact, for subsequent installation and deployment.
AddPluginArtifactMetadataMojo() - Constructor for class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
aggregator() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
aggregator(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
AGGREGATOR - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed as modules.
alias() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
alias(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
analyzeVisitors(MojoClassVisitor) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
AnnotatedContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
AnnotatedContent() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
AnnotatedField - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
AnnotatedField(String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
AntMojoComponentFactory - Class in org.apache.maven.script.ant
AntMojoComponentFactory() - Constructor for class org.apache.maven.script.ant.AntMojoComponentFactory
AntMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.ant: Extracts Mojo descriptors from Ant sources.
AntMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor
AntMojoWrapper - Class in org.apache.maven.script.ant
AntMojoWrapper(AntScriptInvoker) - Constructor for class org.apache.maven.script.ant.AntMojoWrapper
AntPropertyHelper - Class in org.apache.maven.script.ant: Makes the ${expressions} used in Maven available to Ant as properties.
AntPropertyHelper(MavenProject, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper: Deprecated.
use the other constructor
AntPropertyHelper(ExpressionEvaluator, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper: Deprecated.
use AntPropertyHelper.AntPropertyHelper(ExpressionEvaluator, Set, Log) to resolve maven.dependency.* properties
AntPropertyHelper(ExpressionEvaluator, Set<Artifact>, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper
B

BeanshellMojoAdapter - Class in org.apache.maven.script.beanshell: Mojo adapter for a Beanshell Mojo.
BeanshellMojoAdapter(Mojo, Interpreter) - Constructor for class org.apache.maven.script.beanshell.BeanshellMojoAdapter
BeanshellMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.beanshell: Extracts Mojo descriptors from BeanShell sources.
BeanshellMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor
C

canGenerateReport() - Method in class org.apache.maven.plugin.plugin.PluginReport
CLASS_LEVEL_ANNOTATIONS - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
compareTo(AnnotatedField) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
Component - Class in org.apache.maven.plugin.tools.model: A reference to a plexus component, assumed to be available to the plugin container.
Component() - Constructor for class org.apache.maven.plugin.tools.model.Component
Component - Annotation Type in org.apache.maven.plugins.annotations: Used to configure injection of Plexus components by MavenPluginManager.getConfiguredMojo(...)
COMPONENT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Populate the field with an instance of a Plexus component.
COMPONENT_ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Refer to @component role="..."
COMPONENT_ROLEHINT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Refer to @component roleHint="..."
ComponentAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
ComponentAnnotationContent(String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
ComponentAnnotationContent(String, String, String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
configurator() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
configurator(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
CONFIGURATOR - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: The configurator type to use when injecting parameter values into this Mojo.
copyScriptsToOutputDirectory(Map<String, Set<File>>, String, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
createGenerator() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
createGenerator() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
createGenerator() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
createMojoDescriptor(JavaClass) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor




D

DefaultMojoAnnotationsScanner - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner
 
DefaultMojoAnnotationsScanner() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
DefaultMojoScanner - Class in org.apache.maven.tools.plugin.scanner
 
DefaultMojoScanner(Map<String, MojoDescriptorExtractor>) - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner

Default constructor

DefaultMojoScanner() - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner

Empty constructor

defaultPhase() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
defaultPhase(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
DefaultPluginToolsRequest - Class in org.apache.maven.tools.plugin

Default implementation of PluginToolsRequest, which is used to pass parameters to components used to extract
 MojoDescriptor instances from different types of metadata
 for a given plugin.

DefaultPluginToolsRequest(MavenProject, PluginDescriptor) - Constructor for class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
defaultValue() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
defaultValue(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
dependencies - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The set of dependencies for the current project

dependencies - Variable in class org.apache.maven.plugin.plugin.PluginReport

The set of dependencies for the current project

DEPRECATED - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @deprecated <since-text>
 

 Note: Could be defined in a Mojo Type or a Mojo Field.

DESCRIPTION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The description for the Mojo.

DescriptorGeneratorMojo - Class in org.apache.maven.plugin.plugin

Generate a plugin descriptor.

DescriptorGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
 
discoverClasses(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
discoverClasses(String, MavenProject) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
discoverClasses(String, List<File>, Set<Artifact>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
discoverClasses(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 
discoverClassesFromSourcesJar(Artifact, PluginToolsRequest, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
discoverPackageName(PluginDescriptor) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils

Find the best package name, based on the number of hits of actual Mojo classes.





E

element(XMLWriter, String, String) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
 
element(XMLWriter, String, String, boolean) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
 
enableLogging(Logger) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
encoding - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The file encoding of the source files.

equals(Object) - Method in class org.apache.maven.plugin.plugin.Requirements

Method equals.

equals(Object) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
execute() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.HelpMojo
execute() - Method in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
execute() - Method in class org.apache.maven.plugin.plugin.UpdatePluginRegistryMojo
Execute - Annotation Type in org.apache.maven.plugins.annotations

Used if your Mojo needs to fork a lifecycle.

execute() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
execute() - Method in class org.apache.maven.script.beanshell.BeanshellMojoAdapter
 
execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Execute the mojo extraction.

execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
EXECUTE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @execute ...


execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor

Execute the mojo extraction.

execute(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

Execute the mojo extraction.

execute(File, PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.generator.Generator

Execute the generation for a given plugin descriptor.

execute(File, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator

Execute the generation for a given plugin descriptor.

execute(File, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator

Execute the generation for a given plugin descriptor.

execute(File, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.generator.PluginXdocGenerator

Execute the generation for a given plugin descriptor.

EXECUTE_GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo goal will be executed in isolation.

EXECUTE_LIFECYCLE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo will be invoked in a parallel lifecycle.

EXECUTE_PHASE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo will be invoked in a parallel lifecycle, ending at the given phase.

ExecuteAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
 
ExecuteAnnotationContent() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
executeReport(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
EXECUTION_STATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @executionStrategy <strategy>.

executionStrategy() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
executionStrategy(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
ExtendedMojoDescriptor - Class in org.apache.maven.tools.plugin

Extensions to MojoDescriptor added to Maven 3, then are not available when run under Maven2.

ExtendedMojoDescriptor() - Constructor for class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
 
ExtractionException - Exception in org.apache.maven.tools.plugin.extractor

Wrap errors when extraction exception occurred.

ExtractionException(String, Throwable) - Constructor for exception org.apache.maven.tools.plugin.extractor.ExtractionException
 
ExtractionException(String) - Constructor for exception org.apache.maven.tools.plugin.extractor.ExtractionException
 
extractMojoDescriptors(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Should be implemented in the sub classes.

extractMojoDescriptors(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Should be implemented in the sub classes.

extractMojoDescriptorsFromMetadata(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Should be implemented in the sub classes.

extractMojoDescriptorsFromMetadata(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor

Should be implemented in the sub classes.

extractors - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The role names of mojo extractors to use.





F

FIELD_LEVEL_ANNOTATIONS - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
 
findExecuteInParentHierarchy(MojoAnnotatedClass, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
findFieldWithAnnotation(Class<?>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
findSources(String, String) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils
 
findSources(String, String, String) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils
 




G

gatherFilesByBasedir(File, List<String>, String, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
 
Generator - Interface in org.apache.maven.tools.plugin.generator

Generate something, for instance a plugin report, from a plugin descriptor.

GeneratorException - Exception in org.apache.maven.tools.plugin.generator
 
GeneratorException(String, Throwable) - Constructor for exception org.apache.maven.tools.plugin.generator.GeneratorException
 
GeneratorUtils - Class in org.apache.maven.tools.plugin.generator

Convenience methods to play with Maven plugins.

getActiveExtractors() - Method in class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner

Gets the name of the active extractors.

getAddDefaultEntities() - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader

Returns the state of the "add default entities" flag.

getAlias() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get an alternate name for the parameter.

getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet
 
getAllowedParameterNames() - Method in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet
 
getAllowedValue() - Method in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet
 
getAnnotationClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
getAnnotationValues() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
getAnnotationVisitor(Class<?>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
getAnnotationVisitorMap() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
getAntProject() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getArtifact() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getBundle(Locale) - Static method in class org.apache.maven.plugin.plugin.PluginReport
 
getCall() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get the target/method within the script to call when this
 mojo executes.

getClassesDirectories() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
getClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
getClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
getComponentParent(MojoAnnotatedClass, List<ComponentAnnotationContent>, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
getComponents() - Method in class org.apache.maven.plugin.tools.model.Mojo

Method getComponents.

getComponents() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getComponentsParentHierarchy(MojoAnnotatedClass, Map<String, ComponentAnnotationContent>, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
getDefaultValue() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get an expression in the form ${instance.property} for
 extracting a value for this parameter, especially from
             a runtime instance within the build system.

getDependencies() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
getDependencies() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
getDependencies() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

Returns the list of Artifact used in class path scanning for annotations

getDependencyCollectionRequired() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
 
getDeprecated() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
getDeprecation() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get a deprecation message for this mojo parameter.

getDeprecation() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get a deprecation message for this mojo parameter.

getDescription(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
getDescription() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get the description for this parameter.

getDescription() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get the description for this parameter.

getDescription() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
getDiskSpace() - Method in class org.apache.maven.plugin.plugin.Requirements

Get the minimum diskSpace needed to run this plugin.

getEncoding() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

Gets the file encoding of the source files.

getEncoding() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

Gets the file encoding of the source files.

getExecute() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getExecution() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get information about a sub-execution of the Maven lifecycle
 which should be processed.

getExpression() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get the command-line reference to this parameter.

getFieldName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
 
getFieldName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
getFieldVisitors() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
getFromProjectReferences(Artifact, MavenProject) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
getGoal() - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Get a goal, not attached to a lifecycle phase, which should
 be executed ahead of this mojo.

getGoal() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get the name of the goal used to invoke this mojo.

getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet
 
getHeader() - Method in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet
 
getHint() - Method in class org.apache.maven.plugin.tools.model.Component

Get the role-hint to lookup.

getIncludePatterns() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
getInterpreter() - Method in class org.apache.maven.script.beanshell.BeanshellMojoAdapter
 
getJdk() - Method in class org.apache.maven.plugin.plugin.Requirements

Get the minimum version of the JDK to run this plugin.

getLifecycle() - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Get the name of the overlay to apply to the sub-lifecycle
 before executing it.

getLocal() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
getLocal() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
getMaven() - Method in class org.apache.maven.plugin.plugin.Requirements

Get the minimum version of Maven to run this plugin.

getMavenProject() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getMemory() - Method in class org.apache.maven.plugin.plugin.Requirements

Get the minimum memory needed to run this plugin.

getMetadataFile() - Method in exception org.apache.maven.plugin.tools.model.PluginMetadataParseException
 
getMetadataFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Should be implemented in the sub classes.

getMetadataFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor

Should be implemented in the sub classes.

getModelEncoding() - Method in class org.apache.maven.plugin.tools.model.PluginMetadata

Get the modelEncoding field.

getMojo() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getMojoAnnotatedClass() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
getMojoAnnotationVisitor() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
getMojoExecution() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getMojos() - Method in class org.apache.maven.plugin.tools.model.PluginMetadata

Method getMojos.

getName(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
getName() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get the parameter name.

getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet
 
getName() - Method in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet
 
getOriginalMessage() - Method in exception org.apache.maven.plugin.tools.model.PluginMetadataParseException
 
getOthers() - Method in class org.apache.maven.plugin.plugin.Requirements

Method getOthers.

getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
 
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.PluginReport
getOutputName() - Method in class org.apache.maven.plugin.plugin.PluginReport
getParameters() - Method in class org.apache.maven.plugin.tools.model.Mojo

Method getParameters.

getParameters() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getParametersParent(MojoAnnotatedClass, List<ParameterAnnotationContent>, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
getParametersParentHierarchy(MojoAnnotatedClass, Map<String, ParameterAnnotationContent>, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
getParentClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
getPathFromArtifacts(Collection<Artifact>, Project) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getPathTranslator() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getPhase() - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Get the phase in the sub-lifecycle.

getPhase() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get the phase to which this mojo should be bound by default.

getPluginContext() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getPluginDescriptor() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

Return the PluginDescriptor currently being populated as part of the build of the
 current plugin project.

getPluginDescriptor() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

Return the PluginDescriptor currently being populated as part of the build of the
 current plugin project.

getProject() - Method in class org.apache.maven.plugin.plugin.PluginReport
getProject() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

Return the current MavenProject instance in use.

getProject() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
getProject() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

Return the current MavenProject instance in use.

getProperty() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get the JavaBeans property name to use to configure the mojo
 with this parameter.

getPropertyHook(String, String, boolean) - Method in class org.apache.maven.script.ant.AntPropertyHelper
 
getRemoteRepos() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
getRemoteRepos() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
getRequiresDependencyResolution() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get the scope of dependencies that this mojo requires to
 have resolved.

getRole() - Method in class org.apache.maven.plugin.tools.model.Component

Get the component role to lookup.

getRoleClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 
getScriptFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
 
getScriptFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor
getScriptFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor
getScriptInvoker() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getSession() - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
getSince() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get version when the mojo was added to the API.

getSince() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get version when the parameter was added.

getSince() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
getSiteRenderer() - Method in class org.apache.maven.plugin.plugin.PluginReport
getSourceDirectories() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
getType() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get the java type for this parameter.

getVelocityComponent() - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
 
goal() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
goal(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The name for the Mojo that users will reference to execute it.

goalPrefix - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The goal prefix that will appear before the ":".

goalPrefix - Variable in class org.apache.maven.plugin.plugin.PluginReport

The goal prefix that will appear before the ":".





H

hasAnnotationParameters() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
 
hasAnnotations() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
hasAnnotationValue() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
 
hashCode() - Method in class org.apache.maven.plugin.plugin.Requirements

Method hashCode.

hashCode() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet

The Javadoc text which will be added to the generated page

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet

The Javadoc text which will be added to the generated page.

HEADER - Static variable in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet

The Javadoc text which will be added to the generated page.

HelpGeneratorMojo - Class in org.apache.maven.plugin.plugin

Generates a HelpMojo class.

HelpGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.HelpGeneratorMojo
 
HelpMojo - Class in org.apache.maven.plugin.plugin

Display help information on maven-plugin-plugin.

HelpMojo() - Constructor for class org.apache.maven.plugin.plugin.HelpMojo
 
hint() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 
hint(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 




I

id() - Method in enum org.apache.maven.plugins.annotations.InstantiationStrategy
 
id() - Method in enum org.apache.maven.plugins.annotations.LifecyclePhase
 
id() - Method in enum org.apache.maven.plugins.annotations.ResolutionScope
 
IMPL_BASE_PLACEHOLDER - Static variable in class org.apache.maven.plugin.tools.model.PluginMetadataParser

Default implementation path which will be replaced in
 AbstractScriptedMojoDescriptorExtractor#extractMojoDescriptorsFromMetadata(Map, PluginDescriptor)

IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo's fully-qualified class name.

inConstructor() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inConstructor() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
inField() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inField() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
INHERIT_BY_DEFAULT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Allow Mojo inheritance.

inheritByDefault() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
inheritByDefault(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
inMethod() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inMethod() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
inOverview() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inOverview() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
inPackage() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inPackage() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
INSTANTIATION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @instantiationStrategy <per-lookup>.

InstantiationStrategy - Enum in org.apache.maven.plugins.annotations

Component instantiation strategy.

instantiationStrategy() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
instantiationStrategy(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
inType() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
inType() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
isAggregator() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get whether this mojo operates as an aggregator when the
 reactor is run.

isInheritByDefault() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get whether this mojo's configuration should propagate down
 the POM inheritance chain by default.

isInlineTag() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
 
isInlineTag() - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
 
isMavenReport(String, MavenProject) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
 
isReadonly() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get whether this parameter can be directly edited.

isRequired() - Method in class org.apache.maven.plugin.tools.model.Parameter

Get whether this parameter is required.

isRequiresDirectInvocation() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get if true, this mojo can only be directly invoked (eg.

isRequiresOnline() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get whether this mojo requires online mode to operate
 normally.

isRequiresProject() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get whether this mojo requires a project instance in order
 to execute.

isRequiresReports() - Method in class org.apache.maven.plugin.tools.model.Mojo

Get whether this mojo requires a reports section in the POM.

isSkipErrorNoDescriptorsFound() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
isSkipErrorNoDescriptorsFound() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
isThreadSafe() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
 




J

JavaAnnotationsMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.annotations

JavaMojoDescriptorExtractor, a MojoDescriptor extractor to read descriptors from java classes with annotations.

JavaAnnotationsMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
 
JavadocMojoAnnotation - Interface in org.apache.maven.tools.plugin.extractor.javadoc

List of all Javadoc annotations used to describe a java Mojo.

JavaJavadocMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.javadoc

Extracts Mojo descriptors from Java sources.

JavaJavadocMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 




L

LANGUAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The implementation language for the Mojo.

lifecycle() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
lifecycle(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
LifecycleExecution - Class in org.apache.maven.plugin.tools.model

A sub-process execution of a lifecycle to satisfy the
 needs of a mojo.

LifecycleExecution() - Constructor for class org.apache.maven.plugin.tools.model.LifecycleExecution
 
LifecyclePhase - Enum in org.apache.maven.plugins.annotations

Lifecycle phases.

local - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

Location of the local repository.

local - Variable in class org.apache.maven.plugin.plugin.PluginReport

Location of the local repository.





M

makeHtmlValid(String) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils

Fixes some javadoc comment to become a valid XHTML snippet.

MAVEN_COMPONENTS - Static variable in class org.apache.maven.tools.plugin.util.PluginUtils

Deprecated.
wrong approach (fake components), documented parameter default values instead to learn people how to
             discover them


Mojo - Class in org.apache.maven.plugin.tools.model

Mojo descriptor definition.

Mojo() - Constructor for class org.apache.maven.plugin.tools.model.Mojo
 
Mojo - Annotation Type in org.apache.maven.plugins.annotations

This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).

MojoAggregatorTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @aggregator tag is used to aggregate the Maven project and its child modules and
 has no parameter.

MojoAggregatorTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet
 
MojoAnnotatedClass - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner
 
MojoAnnotatedClass() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
MojoAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
 
MojoAnnotationContent() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
MojoAnnotationsScanner - Interface in org.apache.maven.tools.plugin.extractor.annotations.scanner
 
MojoAnnotationsScannerRequest - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner
 
MojoAnnotationsScannerRequest() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
MojoAnnotationVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors
 
MojoClassVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors
 
MojoClassVisitor(Logger) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
MojoComponentFieldTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @parameter tag is used to populate Plexus component and has annotation parameters.

MojoComponentFieldTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet
 
MojoConfiguratorTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @configurator tag is used to inject parameter values into the Mojo and has annotation parameter.

MojoConfiguratorTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
 
MojoDescriptorExtractor - Interface in org.apache.maven.tools.plugin.extractor
 
MojoExecuteTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @execute tag is used to reference the invocation way of the Mojo and has parameters.

MojoExecuteTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet
 
MojoExecutionStrategyTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @executionStrategy tag is used to specify the instantiation strategy and has has parameter.

MojoExecutionStrategyTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet
 
MojoFieldVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors
 
MojoGoalTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @goal tag is used to reference the goal name of the Mojo and has annotation parameter.

MojoGoalTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet
 
MojoInheritByDefaultTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @inheritByDefault tag is used to run this Mojo inside of a project
 and has annotation parameter.

MojoInheritByDefaultTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet
 
MojoInstantiationStrategyTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @instantiationStrategy tag is used to specify the instantiation strategy and has has parameter.

MojoInstantiationStrategyTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet
 
MojoParameterFieldTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @parameter tag is used to define a Mojo parameter and has annotation parameter.

MojoParameterFieldTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet
 
MojoPhaseTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @phase tag is used to reference the binded phase name of the Mojo and has has parameter.

MojoPhaseTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet
 
MojoReadOnlyFieldTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @readonly tag is used to specify that this parameter cannot be configured directly by the
 user and has no parameter.

MojoReadOnlyFieldTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet
 
MojoRequiredFieldTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @required tag is used to specify that this parameter is required for the Mojo
 and has no parameter.

MojoRequiredFieldTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
 
MojoRequiresDependencyCollectionTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresDependencyCollection tag is used to specify the required dependencies in the specified scope
 and has parameter.

MojoRequiresDependencyCollectionTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
 
MojoRequiresDependencyResolutionTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresDependencyResolution tag is used to specify the required dependencies in the specified scope
 and has parameter.

MojoRequiresDependencyResolutionTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet
 
MojoRequiresDirectInvocationTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresDirectInvocation tag is used to allow this Mojo to be direct invoked by the user.

MojoRequiresDirectInvocationTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet
 
MojoRequiresOnLineTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresOnline tag is used to specify that this Mojo should be online
 and has parameter.

MojoRequiresOnLineTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet
 
MojoRequiresProjectTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresProject tag is used to run this Mojo inside of a project
 and has parameter.

MojoRequiresProjectTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet
 
MojoRequiresReportsTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @requiresReports tag is used to run this Mojo inside reports
 and has parameter.

MojoRequiresReportsTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet
 
mojoScanner - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The component used for scanning the source tree for mojos.

mojoScanner - Variable in class org.apache.maven.plugin.plugin.PluginReport

Mojo scanner tools.

MojoScanner - Interface in org.apache.maven.tools.plugin.scanner
 
MojoThreadSafeTypeTaglet - Class in org.apache.maven.tools.plugin.javadoc

The @threadSafe tag is used to indicate that a mojo is thread-safe and can be run in parallel
 

 The following is a sample declaration:
 
 /**
  * Dummy Mojo.

MojoThreadSafeTypeTaglet() - Constructor for class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet
 
MULTI_EXECUTION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Deprecated.
use @executionStrategy always instead






N

name() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
name(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
name() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
name(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
newInstance(ComponentDescriptor, ClassRealm, PlexusContainer) - Method in class org.apache.maven.script.ant.AntMojoComponentFactory
 




O

org.apache.maven.plugin.plugin - package org.apache.maven.plugin.plugin
 
org.apache.maven.plugin.plugin.metadata - package org.apache.maven.plugin.plugin.metadata
 
org.apache.maven.plugin.tools.model - package org.apache.maven.plugin.tools.model
 
org.apache.maven.plugin.tools.model.io.xpp3 - package org.apache.maven.plugin.tools.model.io.xpp3
 
org.apache.maven.plugins.annotations - package org.apache.maven.plugins.annotations
 
org.apache.maven.script.ant - package org.apache.maven.script.ant
 
org.apache.maven.script.beanshell - package org.apache.maven.script.beanshell
 
org.apache.maven.tools.plugin - package org.apache.maven.tools.plugin
 
org.apache.maven.tools.plugin.extractor - package org.apache.maven.tools.plugin.extractor
 
org.apache.maven.tools.plugin.extractor.annotations - package org.apache.maven.tools.plugin.extractor.annotations
 
org.apache.maven.tools.plugin.extractor.annotations.datamodel - package org.apache.maven.tools.plugin.extractor.annotations.datamodel
 
org.apache.maven.tools.plugin.extractor.annotations.scanner - package org.apache.maven.tools.plugin.extractor.annotations.scanner
 
org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors - package org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors
 
org.apache.maven.tools.plugin.extractor.ant - package org.apache.maven.tools.plugin.extractor.ant
 
org.apache.maven.tools.plugin.extractor.beanshell - package org.apache.maven.tools.plugin.extractor.beanshell
 
org.apache.maven.tools.plugin.extractor.javadoc - package org.apache.maven.tools.plugin.extractor.javadoc
 
org.apache.maven.tools.plugin.generator - package org.apache.maven.tools.plugin.generator
 
org.apache.maven.tools.plugin.javadoc - package org.apache.maven.tools.plugin.javadoc



  Mojo Javadoc Tags used by Maven Plugins
  Here is a reference of the Javadoc annotations that can be used to 'decorate' the Java sources
    to allow Mojo to generate descriptors.

org.apache.maven.tools.plugin.scanner - package org.apache.maven.tools.plugin.scanner
 
org.apache.maven.tools.plugin.util - package org.apache.maven.tools.plugin.util
 
outputDirectory - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

The directory where the generated plugin.xml file will be put.

outputDirectory - Variable in class org.apache.maven.plugin.plugin.HelpGeneratorMojo

The directory where the generated HelpMojo file will be put.





P

packagingTypes - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

Maven plugin packaging types.

Parameter - Class in org.apache.maven.plugin.tools.model

A parameter used by a mojo, and configurable from the
 command line or POM configuration sections.

Parameter() - Constructor for class org.apache.maven.plugin.tools.model.Parameter
 
Parameter - Annotation Type in org.apache.maven.plugins.annotations

Used to configure your Mojo parameters to be injected by
 
 MavenPluginManager.getConfiguredMojo(...)


PARAMETER - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @parameter ...


PARAMETER_ALIAS - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

This defines an alias which can be used to configure a parameter.

PARAMETER_DEFAULT_VALUE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

This defines the default value to be injected into this parameter of the Mojo at build time.

PARAMETER_EXPRESSION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Deprecated.
use PARAMETER_PROPERTY instead


PARAMETER_IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

This defines the default implementation in the case the parameter type is an interface.

PARAMETER_NAME - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

This defines the name of the bean property used to get/set the field: by default, field name is used.

PARAMETER_PROPERTY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

This defines the property used to calculate the value to be injected into this parameter of the
 Mojo at build time, which can come from -D execution, setting properties or pom properties.

ParameterAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
 
ParameterAnnotationContent(String, String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
ParameterAnnotationContent(String, String, String, String, boolean, boolean, String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
parseMojoDescriptors(File) - Method in class org.apache.maven.plugin.tools.model.PluginMetadataParser
 
phase() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
phase(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
PHASE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @phase <phaseName>.

PluginDescriptorGenerator - Class in org.apache.maven.tools.plugin.generator

Generate a Maven Plugin Descriptor XML file and
 corresponding plugin-help.xml help content for PluginHelpGenerator.

PluginDescriptorGenerator(Log) - Constructor for class org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator
 
PluginHelpGenerator - Class in org.apache.maven.tools.plugin.generator

Generates an HelpMojo class from help-class-source.vm template.

PluginHelpGenerator() - Constructor for class org.apache.maven.tools.plugin.generator.PluginHelpGenerator

Default constructor

PluginMetadata - Class in org.apache.maven.plugin.tools.model

Root element of a script-based mojo's plugin metadata bindings.

PluginMetadata() - Constructor for class org.apache.maven.plugin.tools.model.PluginMetadata
 
PluginMetadataParseException - Exception in org.apache.maven.plugin.tools.model

Exception when plugin metadata parsing occurred.

PluginMetadataParseException(File, String, Throwable) - Constructor for exception org.apache.maven.plugin.tools.model.PluginMetadataParseException
 
PluginMetadataParseException(File, String) - Constructor for exception org.apache.maven.plugin.tools.model.PluginMetadataParseException
 
PluginMetadataParser - Class in org.apache.maven.plugin.tools.model

Parser for plugin metadata.

PluginMetadataParser() - Constructor for class org.apache.maven.plugin.tools.model.PluginMetadataParser
 
PluginMetadataXpp3Reader - Class in org.apache.maven.plugin.tools.model.io.xpp3

Class PluginMetadataXpp3Reader.

PluginMetadataXpp3Reader() - Constructor for class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader
 
PluginMetadataXpp3Writer - Class in org.apache.maven.plugin.tools.model.io.xpp3

Class PluginMetadataXpp3Writer.

PluginMetadataXpp3Writer() - Constructor for class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Writer
 
PluginReport - Class in org.apache.maven.plugin.plugin

Generates the Plugin's documentation report: plugin-info.html plugin overview page,
 and one goal-mojo.html per goal.

PluginReport() - Constructor for class org.apache.maven.plugin.plugin.PluginReport
 
PluginToolsRequest - Interface in org.apache.maven.tools.plugin

Request that encapsulates all information relevant to the process of extracting
 MojoDescriptor
 instances from metadata for a certain type of mojo.

PluginUtils - Class in org.apache.maven.tools.plugin.util

Convenience methods to play with Maven plugins.

PluginXdocGenerator - Class in org.apache.maven.tools.plugin.generator

Generate xdoc documentation for each mojo.

PluginXdocGenerator() - Constructor for class org.apache.maven.tools.plugin.generator.PluginXdocGenerator

Default constructor using Locale.ENGLISH as locale.

PluginXdocGenerator(MavenProject) - Constructor for class org.apache.maven.tools.plugin.generator.PluginXdocGenerator

Constructor using Locale.ENGLISH as locale.

PluginXdocGenerator(MavenProject, Locale) - Constructor for class org.apache.maven.tools.plugin.generator.PluginXdocGenerator
 
populateAnnotationContent(Object, MojoAnnotationVisitor) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
populateDataFromJavadoc(Map<String, MojoAnnotatedClass>, Map<String, JavaClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

from sources scan to get @since and @deprecated and description of classes and fields.

populatePluginDescriptor(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
populatePluginDescriptor(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.scanner.MojoScanner
 
processMojoDescriptor(MojoDescriptor, XMLWriter) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator
 
processMojoDescriptor(MojoDescriptor, XMLWriter, boolean) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator
 
processMojoDescriptor(MojoDescriptor, File) - Method in class org.apache.maven.tools.plugin.generator.PluginXdocGenerator
 
project - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

The project currently being built.

property() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
property(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 




R

read(Reader, boolean) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader
 
read(Reader) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader
 
read(InputStream, boolean) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader

Method read.

readonly() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
readonly(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
READONLY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
 configuration).

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet

Register this Taglet.

register(Map<String, Taglet>) - Static method in class org.apache.maven.tools.plugin.javadoc.MojoThreadSafeTypeTaglet

Register this Taglet.

remoteRepos - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

List of Remote Repositories used by the resolver

remoteRepos - Variable in class org.apache.maven.plugin.plugin.PluginReport

List of Remote Repositories used by the resolver

removeComponent(Component) - Method in class org.apache.maven.plugin.tools.model.Mojo

Method removeComponent.

removeMojo(Mojo) - Method in class org.apache.maven.plugin.tools.model.PluginMetadata

Method removeMojo.

removeParameter(Parameter) - Method in class org.apache.maven.plugin.tools.model.Mojo

Method removeParameter.

required() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
required(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
REQUIRED - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Specifies that this parameter is required for the Mojo to function.

Requirements - Class in org.apache.maven.plugin.plugin

Plugin requirements.

Requirements() - Constructor for class org.apache.maven.plugin.plugin.Requirements
 
REQUIRES_DEPENDENCY_COLLECTION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected
 before it can execute.

REQUIRES_DEPENDENCY_RESOLUTION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved
 before it can execute.

REQUIRES_DIRECT_INVOCATION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @requiresDirectInvocation <true|false>.

REQUIRES_ONLINE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run online.

REQUIRES_PROJECT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run inside of a project.

REQUIRES_REPORTS - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run inside reports.

requiresDependencyCollection() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresDependencyCollection(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresDependencyResolution() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresDependencyResolution(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresDirectInvocation() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresDirectInvocation(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresOnline() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresOnline(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresProject() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresProject(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresReports() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
requiresReports(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
ResolutionScope - Enum in org.apache.maven.plugins.annotations

Dependencies resolution scopes available before
 mojo execution.

role() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 
ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
 
ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

Plexus role for lookup

ROLE - Static variable in interface org.apache.maven.tools.plugin.scanner.MojoScanner

Plexus role for lookup





S

scan(MojoAnnotationsScannerRequest) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
scan(Map<String, MojoAnnotatedClass>, File, List<String>, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
scan(MojoAnnotationsScannerRequest) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

Scan classes for mojo annotations.

scanArchive(File, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
scanDirectory(File, List<String>, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
 
setActiveExtractors(Set<String>) - Method in class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
 
setActiveExtractors(Set<String>) - Method in interface org.apache.maven.tools.plugin.scanner.MojoScanner

Sets the active extractors.

setAddDefaultEntities(boolean) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Reader

Sets the state of the "add default entities" flag.

setAggregator(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set whether this mojo operates as an aggregator when the
 reactor is run.

setAlias(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set an alternate name for the parameter.

setAnnotationVisitorMap(Map<String, MojoAnnotationVisitor>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
setAntProject(Project) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setArtifact(Artifact) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setCall(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set the target/method within the script to call when this
 mojo executes.

setClassesDirectories(List<File>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
setClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
setClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
setComponentConfiguration(Map) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setComponents(List<Component>) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set list of plexus components required by this mojo.

setComponents(Map<String, ComponentAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setDefaultValue(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set an expression in the form ${instance.property} for
 extracting a value for this parameter, especially from
             a runtime instance within the build system.

setDependencies(Set<Artifact>) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
setDependencies(Set<Artifact>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
setDependencies(Set<Artifact>) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
setDependencyCollectionRequired(String) - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
 
setDeprecated(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
setDeprecation(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set a deprecation message for this mojo parameter.

setDeprecation(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set a deprecation message for this mojo parameter.

setDescription(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set the description for this parameter.

setDescription(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set the description for this parameter.

setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
setDiskSpace(String) - Method in class org.apache.maven.plugin.plugin.Requirements

Set the minimum diskSpace needed to run this plugin.

setEncoding(String) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

Sets the file encoding of the source files.

setEncoding(String) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

Sets the file encoding of the source files.

setExecute(ExecuteAnnotationContent) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setExecution(LifecycleExecution) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set information about a sub-execution of the Maven lifecycle
 which should be processed.

setExpression(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set the command-line reference to this parameter.

setFieldName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
 
setFieldVisitors(List<MojoFieldVisitor>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
setGoal(String) - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Set a goal, not attached to a lifecycle phase, which should
 be executed ahead of this mojo.

setGoal(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set the name of the goal used to invoke this mojo.

setHelpPackageName(String) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
 
setHint(String) - Method in class org.apache.maven.plugin.tools.model.Component

Set the role-hint to lookup.

setIncludePatterns(List<String>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
setInheritByDefault(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set whether this mojo's configuration should propagate down
 the POM inheritance chain by default.

setJdk(String) - Method in class org.apache.maven.plugin.plugin.Requirements

Set the minimum version of the JDK to run this plugin.

setLifecycle(String) - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Set the name of the overlay to apply to the sub-lifecycle
 before executing it.

setLocal(ArtifactRepository) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
setLocal(ArtifactRepository) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
setMaven(String) - Method in class org.apache.maven.plugin.plugin.Requirements

Set the minimum version of Maven to run this plugin.

setMavenProject(MavenProject) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setMemory(String) - Method in class org.apache.maven.plugin.plugin.Requirements

Set the minimum memory needed to run this plugin.

setModelEncoding(String) - Method in class org.apache.maven.plugin.tools.model.PluginMetadata

Set the modelEncoding field.

setMojo(MojoAnnotationContent) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setMojoAnnotatedClass(MojoAnnotatedClass) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
setMojoExecution(MojoExecution) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setMojos(List<Mojo>) - Method in class org.apache.maven.plugin.tools.model.PluginMetadata

Set the list of mojos contained in the accompanying script.

setName(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set the parameter name.

setOthers(Properties) - Method in class org.apache.maven.plugin.plugin.Requirements

Set others requirements properties.

setParameters(List<Parameter>) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set list of parameters used by this mojo.

setParameters(Map<String, ParameterAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setParentClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
setPathTranslator(PathTranslator) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setPhase(String) - Method in class org.apache.maven.plugin.tools.model.LifecycleExecution

Set the phase in the sub-lifecycle.

setPhase(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set the phase to which this mojo should be bound by default.

setPluginContext(Map) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setPluginDescriptor(PluginDescriptor) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
setPluginDescriptor(PluginDescriptor) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
setProject(MavenProject) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
setProject(MavenProject) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
setProject(MavenProject) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
setProperty(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set the JavaBeans property name to use to configure the mojo
 with this parameter.

setReadonly(boolean) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set whether this parameter can be directly edited.

setRemoteRepos(List<ArtifactRepository>) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
 
setRemoteRepos(List<ArtifactRepository>) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
 
setRequired(boolean) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set whether this parameter is required.

setRequiresDependencyResolution(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set the scope of dependencies that this mojo requires to
 have resolved.

setRequiresDirectInvocation(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set if true, this mojo can only be directly invoked (eg.

setRequiresOnline(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set whether this mojo requires online mode to operate
 normally.

setRequiresProject(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set whether this mojo requires a project instance in order
 to execute.

setRequiresReports(boolean) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set whether this mojo requires a reports section in the POM.

setRole(String) - Method in class org.apache.maven.plugin.tools.model.Component

Set the component role to lookup.

setRoleClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 
setSession(MavenSession) - Method in class org.apache.maven.script.ant.AntMojoWrapper
 
setSince(String) - Method in class org.apache.maven.plugin.tools.model.Mojo

Set version when the mojo was added to the API.

setSince(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set version when the parameter was added.

setSince(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
 
setSkipErrorNoDescriptorsFound(boolean) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

By default an exception is throw if no mojo descriptor is found.

setSkipErrorNoDescriptorsFound(boolean) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

By default an exception is throw if no mojo descriptor is found.

setSourceDirectories(List<File>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
 
setThreadSafe(boolean) - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
 
setType(String) - Method in class org.apache.maven.plugin.tools.model.Parameter

Set the java type for this parameter.

setVelocityComponent(VelocityComponent) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
 
SINCE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @since <deprecated-text>
 

 Note: Could be defined in a Mojo Type or a Mojo Field.

skip - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

Set this to "true" to skip invoking any goals or reports of the plugin.

skipErrorNoDescriptorsFound - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

By default an exception is throw if no mojo descriptor is found.

sortMojoParameters(List<Parameter>) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils

Sorts the specified mojo parameters by name.

sortMojos(List<MojoDescriptor>) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils

Sorts the specified mojo descriptors by goal name.





T

THREAD_SAFE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Indicates that this mojo is thread-safe and can be run in parallel.

threadSafe() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
threadSafe(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
toComponentDependencies(List<Dependency>) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
 
toString() - Method in class org.apache.maven.plugin.plugin.Requirements

Method toString.

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
 
toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
 
toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
 
toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
 
toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
 
toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
 
toString(Tag) - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
toString(Tag[]) - Method in class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
toText(String) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils

Converts a HTML fragment as extracted from a javadoc comment to a plain text string.





U

UpdatePluginRegistryMojo - Class in org.apache.maven.plugin.plugin

Update the user plugin registry (if it's in use) to reflect the version we're installing.

UpdatePluginRegistryMojo() - Constructor for class org.apache.maven.plugin.plugin.UpdatePluginRegistryMojo
 




V

validate(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 
validateParameter(Parameter, int) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 
valueOf(String) - Static method in enum org.apache.maven.plugins.annotations.InstantiationStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.maven.plugins.annotations.LifecyclePhase

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.maven.plugins.annotations.ResolutionScope

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.maven.plugins.annotations.InstantiationStrategy

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.maven.plugins.annotations.LifecyclePhase

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum org.apache.maven.plugins.annotations.ResolutionScope

Returns an array containing the constants of this enum type, in
the order they are declared.

visit(String, Object) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
visit(int, int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitAnnotation(String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
visitArray(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
visitAttribute(Attribute) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitAttribute(Attribute) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
visitEnd() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
visitEnd() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitEnd() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
 
visitEnum(String, String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
 
visitField(int, String, String, String, Object) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitInnerClass(String, String, String, int) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitMethod(int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitOuterClass(String, String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 
visitSource(String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
 




W

write(Writer, PluginMetadata) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Writer

Method write.

write(OutputStream, PluginMetadata) - Method in class org.apache.maven.plugin.tools.model.io.xpp3.PluginMetadataXpp3Writer

Method write.

writeDependencies(XMLWriter, PluginDescriptor) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
 
writeDescriptor(File, PluginToolsRequest, boolean) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator
 

A B C D E F G H I J L M N O P R S T U V W