Index
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form
A
- AbstractGeneratorMojo - Class in org.apache.maven.plugin.plugin
-
Abstract class for this Plugin.
- AbstractGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
- 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.tools.plugin.extractor.model.Mojo
-
Method addComponent.
- addComponentRequirement(ComponentRequirement, Object) - Method in class org.apache.maven.script.ant.AntMojoWrapper
- addMojo(Mojo) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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
- addPluginMapping(String, String) - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- addPluginMapping(String, String, String) - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- aggregator() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
if the Mojo uses the Maven project and its child modules.
- 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.
- alias() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
alias supported to get parameter value.
- 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, Set<Artifact>, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper
- AntPropertyHelper(ExpressionEvaluator, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper
-
Deprecated.use
AntPropertyHelper(ExpressionEvaluator, Set, Log)
to resolve maven.dependency.* properties
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
- buildComponentDescriptor(PlexusConfiguration, PluginDescriptor) - Method in class org.apache.maven.plugins.plugin.descriptor.MNG6109PluginDescriptorBuilder
- buildContext - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
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
- CLEAN - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- compareTo(AnnotatedField) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
- COMPILE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- COMPILE - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
compile
resolution scope =compile
+system
+provided
dependencies - COMPILE_PLUS_RUNTIME - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
compile+runtime
resolution scope (Maven 3 only) =compile
+system
+provided
+runtime
dependencies - Component - Class in org.apache.maven.tools.plugin.extractor.model
-
A reference to a plexus component, assumed to be available to the plugin container.
- Component - Annotation Interface in org.apache.maven.plugins.annotations
-
Used to configure injection of Plexus components by
MavenPluginManager.getConfiguredMojo(...)
. - Component() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Component
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
own configurator class.
- 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.
- contentTransformer - Variable in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
-
Field contentTransformer.
- 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() - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
-
Empty constructor
- DefaultMojoScanner(Map<String, MojoDescriptorExtractor>) - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
-
Default constructor
- defaultPhase() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
default phase to bind your mojo.
- 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 extractMojoDescriptor
instances from different types of metadata for a given plugin. - DefaultPluginToolsRequest(MavenProject, PluginDescriptor) - Constructor for class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- defaultValue() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
parameter default value, may contain
${...}
expressions which will be interpreted at inject time: see PluginParameterExpressionEvaluator. - 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
- DEPLOY - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- DEPRECATED - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Refer to
@deprecated <since-text>
- 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(String, List<File>, Set<Artifact>) - 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(PluginToolsRequest) - 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.script.ant.AntMojoWrapper
- execute() - Method in class org.apache.maven.script.beanshell.BeanshellMojoAdapter
- 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(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(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(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
- execute(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Execute the mojo extraction.
- Execute - Annotation Interface in org.apache.maven.plugins.annotations
-
Used if your Mojo needs to fork a lifecycle.
- EXECUTE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Refer to
@execute ...
. - 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- 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) - Constructor for exception org.apache.maven.tools.plugin.extractor.ExtractionException
- ExtractionException(String, Throwable) - 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
- GENERATE_RESOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_SOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_TEST_RESOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_TEST_SOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- 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.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAlias() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get an alternate name for the parameter.
- 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
- getArtifactId() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- getBaseVersion() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- getBundle(Locale) - Static method in class org.apache.maven.plugin.plugin.PluginReport
- getCall() - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- getComponents() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Method getComponents.
- getComponentsParentHierarchy(MojoAnnotatedClass, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
- getDefaultValue() - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.model.Mojo
-
Get a deprecation message for this mojo parameter.
- getDeprecation() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get a deprecation message for this mojo parameter.
- getDescription() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
- getDescription() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get the description for this parameter.
- getDescription() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get the description for this parameter.
- getDescription(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
- 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.tools.plugin.extractor.model.Mojo
-
Get information about a sub-execution of the Maven lifecycle which should be processed.
- getExpression() - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.model.Mojo
-
Get the name of the goal used to invoke this mojo.
- getGroupId() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- getHint() - Method in class org.apache.maven.tools.plugin.extractor.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.
- getKey() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- getLifecycle() - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.model.PluginMetadata
-
Method getMojos.
- getName() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get the parameter name.
- getName(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
- getOriginalMessage() - Method in exception org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- getParameters() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Method getParameters.
- getParametersParent(MojoAnnotatedClass, List<ParameterAnnotationContent>, Map<String, MojoAnnotatedClass>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
- getParametersParentHierarchy(MojoAnnotatedClass, 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.tools.plugin.extractor.model.LifecycleExecution
-
Get the phase in the sub-lifecycle.
- getPhase() - Method in class org.apache.maven.tools.plugin.extractor.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
- getPluginDescriptor() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- getProject() - Method in class org.apache.maven.plugin.plugin.PluginReport
- getProject() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getProject() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
- getProject() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- getProperty() - Method in class org.apache.maven.tools.plugin.extractor.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
- getRepository() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- getRequiresDependencyResolution() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get the scope of dependencies that this mojo requires to have resolved.
- getRole() - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
- getSince() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get version when the mojo was added to the API.
- getSince() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get version when the parameter was added.
- 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.tools.plugin.extractor.model.Parameter
-
Get the java type for this parameter.
- getVelocityComponent() - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
- goal() - Element in annotation interface org.apache.maven.plugins.annotations.Execute
-
goal to fork.
- 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 ":".
- GroupRepositoryMetadata - Class in org.apache.maven.plugin.plugin.metadata
-
Metadata for the group directory of the repository.
- GroupRepositoryMetadata(String) - Constructor for class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
H
- hasAnnotations() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- 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
- 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.
Callmvn plugin:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class org.apache.maven.plugin.plugin.HelpMojo
- hint() - Element in annotation interface org.apache.maven.plugins.annotations.Component
-
hint of the component to inject.
- 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 class org.apache.maven.plugins.annotations.InstantiationStrategy
- id() - Method in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- id() - Method in enum class org.apache.maven.plugins.annotations.ResolutionScope
- IMPL_BASE_PLACEHOLDER - Static variable in class org.apache.maven.tools.plugin.extractor.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.
- INHERIT_BY_DEFAULT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Allow Mojo inheritance.
- inheritByDefault() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- 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
- INITIALIZE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- INSTALL - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- INSTANTIATION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Refer to
@instantiationStrategy <per-lookup>
. - instantiationStrategy() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
your Mojo 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
- InstantiationStrategy - Enum Class in org.apache.maven.plugins.annotations
-
Component instantiation strategy.
- INTEGRATION_TEST - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- isAggregator() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get whether this mojo operates as an aggregator when the reactor is run.
- isInheritByDefault() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get whether this mojo's configuration should propagate down the POM inheritance chain by default.
- isMavenReport(String, MavenProject) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
- isReadonly() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get whether this parameter can be directly edited.
- isRequired() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get whether this parameter is required.
- isRequiresDirectInvocation() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get if true, this mojo can only be directly invoked (eg.
- isRequiresOnline() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get whether this mojo requires online mode to operate normally.
- isRequiresProject() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Get whether this mojo requires a project instance in order to execute.
- isRequiresReports() - Method in class org.apache.maven.tools.plugin.extractor.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
- isSnapshot() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- 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
K
- KEEP_ALIVE - Enum constant in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
L
- LANGUAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
The implementation language for the Mojo.
- lifecycle() - Element in annotation interface org.apache.maven.plugins.annotations.Execute
-
lifecycle id of the lifecycle that defines
Execute.phase()
. - 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.tools.plugin.extractor.model
-
A sub-process execution of a lifecycle to satisfy the needs of a mojo.
- LifecycleExecution() - Constructor for class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution
- LifecyclePhase - Enum Class in org.apache.maven.plugins.annotations
- 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
- MNG6109PluginDescriptorBuilder - Class in org.apache.maven.plugins.plugin.descriptor
-
Reads the plugin descriptor and adds the fix for MNG-6109 when using Maven-3.3.9 and before.
- MNG6109PluginDescriptorBuilder() - Constructor for class org.apache.maven.plugins.plugin.descriptor.MNG6109PluginDescriptorBuilder
- Mojo - Class in org.apache.maven.tools.plugin.extractor.model
-
Mojo descriptor definition.
- Mojo - Annotation Interface in org.apache.maven.plugins.annotations
-
This annotation will mark your class as a Mojo (ie.
- Mojo() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Mojo
- 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
- MojoDescriptorExtractor - Interface in org.apache.maven.tools.plugin.extractor
- MojoFieldVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors
- 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
- MULTI_EXECUTION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Deprecated.use
@executionStrategy always
instead
N
- name() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
goal name (required).
- name() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
name of the bean property used to get/set the field: by default, field name is used.
- name() - 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.MojoAnnotationContent
- 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
- NONE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- NONE - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
empty resolution scope
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.plugins.annotations - package org.apache.maven.plugins.annotations
- org.apache.maven.plugins.plugin.descriptor - package org.apache.maven.plugins.plugin.descriptor
- 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.extractor.model - package org.apache.maven.tools.plugin.extractor.model
- org.apache.maven.tools.plugin.extractor.model.io.xpp3 - package org.apache.maven.tools.plugin.extractor.model.io.xpp3
- org.apache.maven.tools.plugin.generator - package org.apache.maven.tools.plugin.generator
- 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
- PACKAGE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- packagingTypes - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
-
Maven plugin packaging types.
- Parameter - Class in org.apache.maven.tools.plugin.extractor.model
-
A parameter used by a mojo, and configurable from the command line or POM configuration sections.
- Parameter - Annotation Interface in org.apache.maven.plugins.annotations
-
Used to configure your Mojo parameters to be injected by
MavenPluginManager.getConfiguredMojo(...)
. - Parameter() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Parameter
- 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.tools.plugin.extractor.model.PluginMetadataParser
- PER_LOOKUP - Enum constant in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
- phase() - Element in annotation interface org.apache.maven.plugins.annotations.Execute
-
lifecycle phase to fork.
- 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 forPluginHelpGenerator
. - 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 fromhelp-class-source.vm
template. - PluginHelpGenerator() - Constructor for class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
-
Default constructor
- PluginMetadata - Class in org.apache.maven.tools.plugin.extractor.model
-
Root element of a script-based mojo's plugin metadata bindings.
- PluginMetadata() - Constructor for class org.apache.maven.tools.plugin.extractor.model.PluginMetadata
- PluginMetadataParseException - Exception in org.apache.maven.tools.plugin.extractor.model
-
Exception when plugin metadata parsing occurred.
- PluginMetadataParseException(File, String) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
- PluginMetadataParseException(File, String, Throwable) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
- PluginMetadataParser - Class in org.apache.maven.tools.plugin.extractor.model
-
Parser for plugin metadata.
- PluginMetadataParser() - Constructor for class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser
- PluginMetadataXpp3Reader - Class in org.apache.maven.tools.plugin.extractor.model.io.xpp3
-
Class PluginMetadataXpp3Reader.
- PluginMetadataXpp3Reader() - Constructor for class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
- PluginMetadataXpp3Reader(PluginMetadataXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
- PluginMetadataXpp3Reader.ContentTransformer - Interface in org.apache.maven.tools.plugin.extractor.model.io.xpp3
- PluginMetadataXpp3Writer - Class in org.apache.maven.tools.plugin.extractor.model.io.xpp3
-
Class PluginMetadataXpp3Writer.
- PluginMetadataXpp3Writer() - Constructor for class org.apache.maven.tools.plugin.extractor.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 onegoal-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
- POOLABLE - Enum constant in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
- 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
- POST_CLEAN - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- POST_INTEGRATION_TEST - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- POST_SITE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_CLEAN - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_INTEGRATION_TEST - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_SITE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PREPARE_PACKAGE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_CLASSES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_RESOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_SOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_CLASSES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_RESOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_SOURCES - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- processMojoDescriptor(MojoDescriptor, File) - Method in class org.apache.maven.tools.plugin.generator.PluginXdocGenerator
- 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
- project - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
-
The project currently being built.
- property() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
Property to use to retrieve a value.
- 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(InputStream) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
-
Method read.
- read(InputStream, boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
-
Method read.
- read(Reader) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
- read(Reader, boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
- readonly() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
- 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).
- 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.tools.plugin.extractor.model.Mojo
-
Method removeComponent.
- removeMojo(Mojo) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata
-
Method removeMojo.
- removeParameter(Parameter) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Method removeParameter.
- required() - Element in annotation interface org.apache.maven.plugins.annotations.Parameter
-
is the parameter required?
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
the required dependency collection scope.
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
the required dependency resolution scope.
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
does this Mojo need to be online to be executed?
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
does your mojo requires a project to be executed?
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- 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 Class in org.apache.maven.plugins.annotations
-
Dependencies resolution scopes available before mojo execution.
- role() - Element in annotation interface org.apache.maven.plugins.annotations.Component
-
role of the component to inject.
- 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
- RUNTIME - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
runtime
resolution scope =compile
+runtime
dependencies - RUNTIME_PLUS_SYSTEM - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
runtime+system
resolution scope (Maven 3 only) =compile
+system
+runtime
dependencies
S
- 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 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.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAggregator(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set whether this mojo operates as an aggregator when the reactor is run.
- setAlias(String) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.model.Mojo
-
Set a deprecation message for this mojo parameter.
- setDeprecation(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Set a deprecation message for this mojo parameter.
- setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
- setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set the description for this parameter.
- setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Set the description for this parameter.
- 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.tools.plugin.extractor.model.Mojo
-
Set information about a sub-execution of the Maven lifecycle which should be processed.
- setExpression(String) - Method in class org.apache.maven.tools.plugin.extractor.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
- setFileComment(String) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer
-
Method setFileComment.
- setGoal(String) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.model.PluginMetadata
-
Set the list of mojos contained in the accompanying script.
- setName(String) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.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.tools.plugin.extractor.model.LifecycleExecution
-
Set the phase in the sub-lifecycle.
- setPhase(String) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.model.Parameter
-
Set the JavaBeans property name to use to configure the mojo with this parameter.
- setReadonly(boolean) - Method in class org.apache.maven.tools.plugin.extractor.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
- setRepository(ArtifactRepository) - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- setRequired(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Set whether this parameter is required.
- setRequiresDependencyResolution(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set the scope of dependencies that this mojo requires to have resolved.
- setRequiresDirectInvocation(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set if true, this mojo can only be directly invoked (eg.
- setRequiresOnline(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set whether this mojo requires online mode to operate normally.
- setRequiresProject(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set whether this mojo requires a project instance in order to execute.
- setRequiresReports(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set whether this mojo requires a reports section in the POM.
- setRole(String) - Method in class org.apache.maven.tools.plugin.extractor.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.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
- setSince(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set version when the mojo was added to the API.
- setSince(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Set version when the parameter was added.
- 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.tools.plugin.extractor.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>
- SINGLETON - Enum constant in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
- SITE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- SITE_DEPLOY - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- 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.
- storedInArtifactVersionDirectory() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
- storedInGroupDirectory() - Method in class org.apache.maven.plugin.plugin.metadata.GroupRepositoryMetadata
T
- TEST - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- TEST - Enum constant in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
test
resolution scope =compile
+system
+provided
+runtime
+test
dependencies - TEST_COMPILE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- 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() - Element in annotation interface org.apache.maven.plugins.annotations.Mojo
-
is your mojo thread safe (since Maven 3.x)?
- 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(Collection<Artifact>) - 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
- 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.
- transform(String, String) - Method in interface org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader.ContentTransformer
-
Interpolate the value read from the xpp3 document
V
- validate(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
- VALIDATE - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- validateParameter(Parameter, int) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
- valueOf(String) - Static method in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.plugins.annotations.LifecyclePhase
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.apache.maven.plugins.annotations.InstantiationStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.maven.plugins.annotations.LifecyclePhase
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.apache.maven.plugins.annotations.ResolutionScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERIFY - Enum constant in enum class org.apache.maven.plugins.annotations.LifecyclePhase
- visit(int, int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
- visit(String, Object) - 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
- visitAnnotation(String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
- 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(OutputStream, PluginMetadata) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer
-
Method write.
- write(Writer, PluginMetadata) - Method in class org.apache.maven.tools.plugin.extractor.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
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form