- 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 - Annotation Type in org.apache.maven.plugins.annotations
-
- 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(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(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.
- 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.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
-
- 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, ComponentAnnotationContent>, 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(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
- 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.
- 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.
- 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.
- 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(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
- getName() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter
-
Get the parameter name.
- 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, 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.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
-
- 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() - 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 ":".
- 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.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() - 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
-
- 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
-
- 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
-
- isThreadSafe() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
-
- packagingTypes - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
-
Maven plugin packaging types.
- Parameter - Annotation Type in org.apache.maven.plugins.annotations
-
- PARAMETER - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation
-
Refer to @parameter ...
- 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() - Constructor for class org.apache.maven.tools.plugin.extractor.model.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
-
- 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
-
- 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
-
- 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.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, Throwable) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
-
- PluginMetadataParseException(File, String) - 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 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
-
- 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.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(Map<String, ComponentAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
-
- setComponents(List<Component>) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set list of plexus components required by this mojo.
- 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(Map<String, ParameterAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
-
- setParameters(List<Parameter>) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo
-
Set list of parameters used by this mojo.
- 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
-
- 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>
- 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.