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

A

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

Abstract class for this Plugin.

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

AbstractPluginReportRenderer - Class in org.apache.maven.plugin.plugin.report

Base class for all reports generated by the plugin report plugin.

AbstractPluginReportRenderer(Sink, Locale, I18N, MavenProject) - Constructor for class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

AbstractScriptedMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor

Deprecated.

Scripting support for Mojos is deprecated and is planned to be removed in Maven 4.0

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

Deprecated.

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

Deprecated.

addMojo(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

Method addMojo.

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.artifact.repository.metadata.GroupRepositoryMetadata

addPluginMapping(String, String, String) - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

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() - 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

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

AntMojoComponentFactory() - Constructor for class org.apache.maven.script.ant.AntMojoComponentFactory

Deprecated.

AntMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.ant

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

AntMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor

Deprecated.

AntMojoWrapper - Class in org.apache.maven.script.ant

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

AntMojoWrapper(AntScriptInvoker) - Constructor for class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

AntPropertyHelper - Class in org.apache.maven.script.ant

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

AntPropertyHelper(MavenProject, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper

Deprecated.

use the other constructor

AntPropertyHelper(ExpressionEvaluator, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper

Deprecated.

use AntPropertyHelper(ExpressionEvaluator, Set, Log) to resolve maven.dependency.* properties

AntPropertyHelper(ExpressionEvaluator, Set<Artifact>, Log) - Constructor for class org.apache.maven.script.ant.AntPropertyHelper

Deprecated.

B

BeanshellMojoAdapter - Class in org.apache.maven.script.beanshell

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

BeanshellMojoAdapter(Mojo, Interpreter) - Constructor for class org.apache.maven.script.beanshell.BeanshellMojoAdapter

Deprecated.

BeanshellMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.beanshell

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

BeanshellMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Deprecated.

build(Reader, String) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder

buildComponentDescriptor(PlexusConfiguration, PluginDescriptor) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder

buildConfiguration(Reader) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder

Cache the returned configuration for additional evaluation in EnhancedPluginDescriptorBuilder.build(Reader, String).

buildContext - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

C

canGenerateReport() - Method in class org.apache.maven.plugin.plugin.report.PluginReport

canGetUrl() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

canGetUrl() - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

CLASS_LEVEL_ANNOTATIONS - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

clone() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

clone() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

CodeTagConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports inline code tag.

CodeTagConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.CodeTagConverter

compare(MojoDescriptorExtractor, MojoDescriptorExtractor) - Method in class org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator

compareTo(AnnotatedField) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField

compareTo(GroupKey) - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

Compares by group then by order, with special case of GroupKey.JAVA_GROUP group: First, GroupKey.group is considered, if equals to GroupKey.JAVA_GROUP, is always first, other groups are in natural order (string) within same named groups, order is defined by GroupKey.order

Component - Annotation Type in org.apache.maven.plugins.annotations

Deprecated.

Use JSR 330 annotations or Parameter with according default expressions instead.

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

Populate the field with an instance of a Plexus component.

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() - Constructor for class org.apache.maven.tools.plugin.extractor.model.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="...".

COMPONENT_V3 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

COMPONENT_V4 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

ComponentAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel

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

ComponentAnnotationContent(String, String, String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent

configurator() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

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

The configurator type to use when injecting parameter values into this Mojo.

containsXhtmlTextValues() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor

Indicates if the methods ComponentDescriptor.getDescription(), MojoDescriptor.getDeprecated(), Parameter.getDescription() and Parameter.getDeprecated() return XHTML values.

contentTransformer - Variable in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader

Field contentTransformer.

convert(DocletTag, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter

convert(String, String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocInlineTagsToXhtmlConverter

Converts the given text containing arbitrarily many inline javadoc tags with their according HTML replacement.

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block.SeeTagConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.CodeTagConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.DocRootTagConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LinkPlainTagToHtmlConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LinkTagToHtmlConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LiteralTagToHtmlConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.ValueTagConverter

convert(String, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter

convert(String) - Method in interface org.apache.maven.tools.plugin.generator.Converter

convert(String) - Method in class org.apache.maven.tools.plugin.generator.HtmlToPlainTextConverter

Converter - Interface in org.apache.maven.tools.plugin.generator

Interface for processing plugin descriptor values (prior to serialization)

ConverterContext - Interface in org.apache.maven.tools.plugin.extractor.annotations.converter

Context which is passed to JavadocBlockTagsToXhtmlConverter, JavadocInlineTagsToXhtmlConverter, JavadocBlockTagToHtmlConverter and JavadocBlockTagToHtmlConverter.

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

Deprecated.

createLink(String, ConverterContext) - Static method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils

createLink(String, ConverterContext, UnaryOperator<String>) - Static method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils

createLink(FullyQualifiedJavadocReference) - Method in class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Generates a (deep-)link to a HTML page in any of the sites given to the constructor.

createLink(String) - Method in class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Generates a (deep-)link to a HTML page in any of the sites given to the constructor.

createMojoDescriptor(JavaClass) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor

customPhase() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent

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

D

DefaultMojoAnnotationsScanner - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner

Mojo scanner with java annotations.

DefaultMojoAnnotationsScanner() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

DefaultMojoScanner - Class in org.apache.maven.tools.plugin.scanner

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

Default constructor

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

Empty constructor

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

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

DefaultPluginToolsRequest - Class in org.apache.maven.tools.plugin

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

DefaultPluginToolsRequest(MavenProject, PluginDescriptor) - Constructor for class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

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

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

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(JavaProjectBuilder) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

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

discoverJdkRequirement(MavenProject, PluginDescriptor) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

Tries to determine the JDK requirement from the following sources (until one is found) use JDK requirement from plugin descriptor use release configuration of org.apache.maven.plugins:maven-compiler-plugin use maven.compiler.release< property use target configuration of org.apache.maven.plugins:maven-compiler-plugin use maven.compiler.target property

discoverMavenRequirement(MavenProject, PluginDescriptor) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

Tries to determine the Maven requirement from either the plugin descriptor or (if not set) from the Maven prerequisites element in the POM.

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.

discoverRequirements(MavenProject) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

DocRootTagConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports docRoot value tag.

DocRootTagConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.DocRootTagConverter

E

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

enableLogging(Logger) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

EnhancedParameterWrapper - Class in org.apache.maven.tools.plugin

Wrapper around regular Parameter which adds capability to read/write a type javadoc URL

EnhancedParameterWrapper(Parameter) - Constructor for class org.apache.maven.tools.plugin.EnhancedParameterWrapper

EnhancedPluginDescriptorBuilder - Class in org.apache.maven.plugins.plugin.descriptor

Reads enhanced plugin.xml files as generated by PluginDescriptorFilesGenerator and used by PluginReport.

EnhancedPluginDescriptorBuilder(RuntimeInformation) - Constructor for class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder

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

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

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

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

equals(Object) - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

equals(Object) - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

equals(Object) - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

escapeXmlElement(String) - Static method in class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter

Mostly a copy of org.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String).

execute() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

execute() - Method in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo

execute(MavenProject, String) - Static method in class org.apache.maven.plugin.plugin.metadata.LegacySupport

Execute - Annotation Type in org.apache.maven.plugins.annotations

Used if your Mojo needs to fork a lifecycle.

execute() - Method in class org.apache.maven.plugins.maven_plugin_plugin.HelpMojo

execute() - Method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo

execute() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

execute() - Method in class org.apache.maven.script.beanshell.BeanshellMojoAdapter

Deprecated.

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

Deprecated.

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.PluginDescriptorFilesGenerator

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

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.

EXECUTE_V3 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

EXECUTE_V4 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

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.report.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 not supported by Maven 3.2.5.

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

ExtendedMojoDescriptor(boolean) - Constructor for class org.apache.maven.tools.plugin.ExtendedMojoDescriptor

ExtendedPluginDescriptor - Class in org.apache.maven.tools.plugin

Extensions to PluginDescriptor not supported by Maven 3.2.5.

ExtendedPluginDescriptor(PluginDescriptor) - Constructor for class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

extendJavaProjectBuilderWithSourcesJar(JavaProjectBuilder, Artifact, PluginToolsRequest, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

externalJavadocBaseUrls - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

Creates links to existing external javadoc-generated documentation.

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

Deprecated.

Should be implemented in the sub classes.

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

Deprecated.

Should be implemented in the sub classes.

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

Deprecated.

Should be implemented in the sub classes.

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

Deprecated.

Should be implemented in the sub classes.

F

FIELD_LEVEL_ANNOTATIONS - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

findClassWithExecuteAnnotationInParentHierarchy(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

findFieldWithAnnotation(Set<String>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

findParameterVisitors() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

findParameterVisitors(Set<String>) - 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

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

Wraps a fully qualified (and resolved) code reference used in javadoc tags see, link and linkplain.

FullyQualifiedJavadocReference(String, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference(String, Optional<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference(String, String, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference(String, String, String, FullyQualifiedJavadocReference.MemberType, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference(String, Optional<String>, Optional<String>, Optional<FullyQualifiedJavadocReference.MemberType>, Optional<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference(Optional<String>, Optional<String>, Optional<String>, Optional<String>, Optional<FullyQualifiedJavadocReference.MemberType>, Optional<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

FullyQualifiedJavadocReference.MemberType - Enum in org.apache.maven.tools.plugin.javadoc

The type of the member part of the reference.

G

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

Deprecated.

generate() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

generate() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

generate() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo

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.

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.EnhancedParameterWrapper

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

Get an alternate name for the parameter.

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

getAnnotationVisitor(String) - 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.MojoFieldVisitor

getAnnotationVisitorMap() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

getAnnotationVisitorMap() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor

getAntProject() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

getArtifact() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

getArtifactId() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

getArtifactId() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getArtifactMap() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getArtifacts() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getAttribute(String, Class<T>, T) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Retrieves some attribute value from the current context.

getAttribute(String, Class<T>, T) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getBaseVersion() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

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

getClassName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

getClassName() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor

getClassName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

getClassRealm() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getClassVersion() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

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.EnhancedParameterWrapper

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

getDeprecated() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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.report.PluginReport

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

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

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.

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.

getEnhancedDescriptorFilePath(MavenProject) - Static method in class org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator

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.EnhancedParameterWrapper

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

Get the command-line reference to this parameter.

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

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

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

getFieldName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

getFieldName() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor

getFromProjectReferences(Artifact, MavenProject) - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

getFullyQualifiedClassName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

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.

getGoalPrefix() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getGroup() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

Returns the group this key belongs to, never null.

getGroupId() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

getGroupId() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getGroupKey() - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

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

Deprecated.

getGroupKey() - Method in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Deprecated.

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

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

Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups.

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

Get the role-hint to lookup.

getI18nSection() - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

getI18nSection() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer

getI18nString(String) - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

Returns

getI18nString(String, String) - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

getId() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getImplementation() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

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

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

getInternalJavadocSiteBaseUrl() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Returns the base url to use for internal javadoc links

getInternalJavadocSiteBaseUrl() - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getInternalJavadocSiteBaseUrl() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

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

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

getInterpreter() - Method in class org.apache.maven.script.beanshell.BeanshellMojoAdapter

Deprecated.

getIntroducedDependencyArtifacts() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getJdk() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

getKey() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

getLabel() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

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.

getLifecycleMapping(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getLocation() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

getLocation() - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getMaven() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

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

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

Deprecated.

getMember() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

getMemberType() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

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

Deprecated.

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

Deprecated.

Should be implemented in the sub classes.

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

Deprecated.

Should be implemented in the sub classes.

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

Get the modelEncoding field.

getModuleName() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

getModuleName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getModuleName() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

getMojo(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

getMojoExecution() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

getMojos() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

Method getMojos.

getName(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport

getName() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

getName() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

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

Deprecated.

getName() - Method in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Deprecated.

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

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

Get the parameter name.

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

Returns the "name" (id) of the extractor.

getOrder() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

Returns the order within same group of this key.

getOriginalMessage() - Method in exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException

Deprecated.

getOutputName() - Method in class org.apache.maven.plugin.plugin.report.PluginReport

getPackageName() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

getPackageName() - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getPackageName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

getPackageNameClassName() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

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

Deprecated.

getPathTranslator() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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.

getPlugin() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getPluginArtifact() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getPluginContext() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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

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

getPluginLookupKey() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

Deprecated.

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

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

Return a Repository Session

getRepository() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

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

getRequiredJavaVersion() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

The default implementation returns null.

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

getRequiredMavenVersion() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getRequirement() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

Deprecated.

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

Deprecated.

getScriptFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Deprecated.

getScriptInvoker() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

getSession() - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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

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

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

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.

getSource() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

getStaticFieldValue(FullyQualifiedJavadocReference) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Returns the value of a referenced static field.

getStaticFieldValue(FullyQualifiedJavadocReference) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

getTitle() - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

getTitle() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer

getType() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

Get the java type for this parameter.

getTypeJavadocUrl() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

getTypeParameters() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor

getTypeParameters() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

getTypeParameters() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor

getUrl(FullyQualifiedJavadocReference) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Returns a (deep-)link to the javadoc page for the given reference

getUrl(FullyQualifiedJavadocReference) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

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

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

getVersion() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

getVersion() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

getVersion() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

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 ":".

GoalRenderer - Class in org.apache.maven.plugin.plugin.report

GoalRenderer(Sink, I18N, Locale, MavenProject, MojoDescriptor, File, boolean, Log) - Constructor for class org.apache.maven.plugin.plugin.report.GoalRenderer

GroupKey - Class in org.apache.maven.tools.plugin.extractor

Group key: defines "grouping" for descriptor (based on source of extraction) and rank within group.

GroupKey(String, int) - Constructor for class org.apache.maven.tools.plugin.extractor.GroupKey

GroupRepositoryMetadata - Class in org.apache.maven.artifact.repository.metadata

Metadata for the group directory of the repository.

GroupRepositoryMetadata(String) - Constructor for class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

H

hasAnnotations() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

hashCode() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

hashCode() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor

hashCode() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

hashCode() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

hashCode() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

hashCode() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

hasSameRequirements(RequirementsHistory) - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

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.plugins.maven_plugin_plugin

Display help information on maven-plugin-plugin.
Call mvn plugin:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.apache.maven.plugins.maven_plugin_plugin.HelpMojo

HelpMojo - Class in org.apache.maven.plugins.maven_plugin_report_plugin

Display help information on maven-plugin-report-plugin.
Call mvn plugin-report:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo

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

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

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

Replaces (X)HTML content by plain text equivalent.

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

I

id() - Method in enum org.apache.maven.plugins.annotations.InstantiationStrategy

id() - Method in enum org.apache.maven.plugins.annotations.LifecyclePhase

id() - Method in enum org.apache.maven.plugins.annotations.ResolutionScope

IMPL_BASE_PLACEHOLDER - Static variable in class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser

Deprecated.

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

INSTANCE - Static variable in class org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator

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

internalJavadocBaseUrl - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

The base URL for the Javadoc site containing the current project's API documentation.

internalJavadocVersion - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo

The version of the javadoc tool (equal to the container JDK version) used to generate the internal javadoc Only relevant if DescriptorGeneratorMojo.internalJavadocBaseUrl is set.

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.

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

isAnnotationOnMethod() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor

isAnnotationOnMethod() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

isAnnotationOnMethod() - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor

isDeprecated() - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Deprecated.

isDeprecated() - Method in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

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

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

Returns true if extractor is deprecated.

isEditable() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

isExternal() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

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.

isInheritedByDefault() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

isLinkValid(URI, Path) - Static method in class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Checks if a given link is valid.

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

Deprecated.

Use PluginUtils.isMavenReport(String, MavenProject) instead.

isMavenReport(String, MavenProject) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils

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

Get whether this parameter can be directly edited.

isReferencedBy(FullyQualifiedJavadocReference) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

isReferencedBy(FullyQualifiedJavadocReference) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

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

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.artifact.repository.metadata.GroupRepositoryMetadata

isV4Api() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor

isV4Api() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

J

JAVA_GROUP - Static variable in class org.apache.maven.tools.plugin.extractor.GroupKey

Java group is handled a bit special: is always first to be scanned.

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

JavaClassConverterContext - Class in org.apache.maven.tools.plugin.extractor.annotations.converter

ConverterContext based on QDox's JavaClass and JavaProjectBuilder.

JavaClassConverterContext(JavaClass, JavaProjectBuilder, Map<String, MojoAnnotatedClass>, JavadocLinkGenerator, int) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

JavaClassConverterContext(JavaClass, JavaClass, JavaProjectBuilder, Map<String, MojoAnnotatedClass>, JavadocLinkGenerator, int) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

JavadocBlockTagsToXhtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter

Converts a given javadoc block taglet to HTML.

JavadocBlockTagsToXhtmlConverter(JavadocInlineTagsToXhtmlConverter, Map<String, JavadocBlockTagToHtmlConverter>) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter

JavadocBlockTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block

Converts a Javadoc block tag to HTML format.

JavadocBlockTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block.JavadocBlockTagToHtmlConverter

JavadocInlineTagsToXhtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter

Replaces inline javadoc taglets by their according XHTML representation.

JavadocInlineTagsToXhtmlConverter(Map<String, JavadocInlineTagToHtmlConverter>) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocInlineTagsToXhtmlConverter

JavadocInlineTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Converts a Javadoc inline tag to HTML format.

JavadocInlineTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.JavadocInlineTagToHtmlConverter

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

Generates links for elements (packages, classes, fields, constructors, methods) in external and/or an internal (potentially not yet existing) javadoc site.

JavadocLinkGenerator(URI, String) - Constructor for class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Constructor for an offline internal site only.

JavadocLinkGenerator(List<URI>, Settings) - Constructor for class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Constructor for online external sites only.

JavadocLinkGenerator(URI, String, List<URI>, Settings) - Constructor for class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator

Constructor for both an internal (offline) and external (online) sites.

JavadocLinkGenerator.JavadocToolVersionRange - Enum in org.apache.maven.tools.plugin.javadoc

Javadoc tool version ranges whose generated sites expose different link formats.

JavadocMojoAnnotation - Interface in org.apache.maven.tools.plugin.extractor.javadoc

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

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

Describes a code reference used in javadoc tags see, link and linkplain.

JavadocTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag

Common base class of both JavadocBlockTagToHtmlConverter and JavadocInlineTagToHtmlConverter.

JavadocTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter

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

Extracts Mojo descriptors from Java source javadoc comments only.

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

L

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

The implementation language for the Mojo.

LegacySupport - Class in org.apache.maven.plugin.plugin.metadata

LegacySupport() - Constructor for class org.apache.maven.plugin.plugin.metadata.LegacySupport

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 in org.apache.maven.plugins.annotations

Lifecycle phases.

LinkPlainTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports inline linkplain taglet.

LinkPlainTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LinkPlainTagToHtmlConverter

LinkTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports inline link tag.

LinkTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LinkTagToHtmlConverter

LinkUtils - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag

Utility methods for dealing with links generated from Javadoc tags.

LiteralTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports inline literal tag.

LiteralTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.LiteralTagToHtmlConverter

locale - Variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

LS - Static variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

System/OS line separator: used to format console messages.

M

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

Deprecated.

Redundant for java extractor

METHOD_LEVEL_ANNOTATIONS - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

Mojo - Annotation Type in org.apache.maven.plugins.annotations

This annotation will mark your class as a Mojo (ie.

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

Mojo descriptor definition.

Mojo() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Mojo

MOJO_V3 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

MOJO_V4 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

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

Visitor for annotations.

MojoClassVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors

Visitor for Mojo classes.

MojoClassVisitor() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

MojoDescriptorExtractor - Interface in org.apache.maven.tools.plugin.extractor

MojoDescriptorExtractorComparator - Class in org.apache.maven.tools.plugin.extractor

Comparator of MojoDescriptorExtractor by MojoDescriptorExtractor.getGroupKey().

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

MojoFieldVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors

Visitors for fields.

MojoMethodVisitor - Class in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors

Method visitor.

MojoMethodVisitor(String, String, List<String>) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

MojoParameterVisitor - Interface in org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors

Common interface for field and method visitors.

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

MVN4_API - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

N

name() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

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

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

NAME - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

NAME - Static variable in class org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor

Deprecated.

NAME - Static variable in class org.apache.maven.tools.plugin.extractor.beanshell.BeanshellMojoDescriptorExtractor

Deprecated.

NAME - Static variable in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor

newInstance(ComponentDescriptor, ClassRealm, PlexusContainer) - Method in class org.apache.maven.script.ant.AntMojoComponentFactory

Deprecated.

O

org.apache.maven.artifact.repository.metadata - package org.apache.maven.artifact.repository.metadata

org.apache.maven.plugin.plugin - package org.apache.maven.plugin.plugin

org.apache.maven.plugin.plugin.metadata - package org.apache.maven.plugin.plugin.metadata

org.apache.maven.plugin.plugin.report - package org.apache.maven.plugin.plugin.report

org.apache.maven.plugins.annotations - package org.apache.maven.plugins.annotations

org.apache.maven.plugins.maven_plugin_plugin - package org.apache.maven.plugins.maven_plugin_plugin

org.apache.maven.plugins.maven_plugin_report_plugin - package org.apache.maven.plugins.maven_plugin_report_plugin

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.converter - package org.apache.maven.tools.plugin.extractor.annotations.converter

org.apache.maven.tools.plugin.extractor.annotations.converter.tag - package org.apache.maven.tools.plugin.extractor.annotations.converter.tag

org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block - package org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block

org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline - package org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

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.javadoc - package org.apache.maven.tools.plugin.javadoc

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.HelpGeneratorMojo

The directory where the generated HelpMojo file will be put.

P

Parameter - Annotation Type in org.apache.maven.plugins.annotations

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

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

Refer to @parameter ...

Parameter - 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

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.

PARAMETER_V3 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

PARAMETER_V4 - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

ParameterAnnotationContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel

ParameterAnnotationContent(String, String, List<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent

ParameterAnnotationContent(String, String, String, String, boolean, boolean, String, List<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent

parse(String) - Static method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

parseMojoDescriptors(File) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser

Deprecated.

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>.

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

Serializes a standard Maven Plugin Descriptor XML file a descriptor containing a limited set of elements for PluginHelpGenerator an enhanced descriptor containing HTML values for some elements (instead of plain text as for the other two) for org.apache.maven.plugin.plugin.report.GoalRenderer from a given in-memory descriptor.

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

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

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

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

Deprecated.

PluginMetadataParseException(File, String) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException

Deprecated.

PluginMetadataParser - Class in org.apache.maven.tools.plugin.extractor.model

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

PluginMetadataParser() - Constructor for class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser

Deprecated.

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

PluginNoForkReport - Class in org.apache.maven.plugin.plugin.report

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

PluginNoForkReport() - Constructor for class org.apache.maven.plugin.plugin.report.PluginNoForkReport

PluginReport - Class in org.apache.maven.plugin.plugin.report

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.report.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.

populateAnnotationContent(Object, MojoAnnotationVisitor) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

populateDataFromJavadoc(JavaProjectBuilder, Map<String, MojoAnnotatedClass>, Map<String, JavaClass>, JavadocLinkGenerator) - 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, PluginDescriptorFilesGenerator.DescriptorType, JavadocLinkGenerator) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator

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

The project currently being built.

project - Variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer

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(XmlPullParser, boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader

Method read.

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

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

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

Method read.

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

Method read.

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

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

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

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

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.

renderBody() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer

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.

RequirementsHistory - Class in org.apache.maven.plugin.plugin.report

Plugin requirements history.

RequirementsHistory() - Constructor for class org.apache.maven.plugin.plugin.report.RequirementsHistory

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

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

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

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

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

Refer to @requiresDirectInvocation <true|false>.

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

Flags this Mojo to run online.

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

Flags this Mojo to run inside of a project.

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

Flags this Mojo to run inside reports.

requiresDependencyCollection() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

requiresDependencyResolution() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

requiresDirectInvocation() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresDirectInvocation(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresOnline() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresOnline(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresProject() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresProject(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresReports() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

requiresReports(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

Dependencies resolution scopes available before mojo execution.

resolveReference(JavadocReference) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Resolves a given javadoc reference, according to the rules of Javadoc's search order.

resolveReference(JavadocReference) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

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

S

scan(MojoAnnotationsScannerRequest) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

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

scan(MojoAnnotationsScannerRequest) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

Scan classes for mojo annotations.

scanArchive(File, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

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

SeeTagConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block

Supports block see taglet.

SeeTagConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block.SeeTagConverter

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.EnhancedParameterWrapper

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

Set an alternate name for the parameter.

setAntProject(Project) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

setArtifact(Artifact) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

setArtifactId(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setArtifacts(List<Artifact>) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setAttribute(String, T) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext

Stores some attribute in the current context

setAttribute(String, T) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavaClassConverterContext

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

setClassRealm(ClassRealm) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setClassVersion(int) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

setComponentConfiguration(Map) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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.EnhancedParameterWrapper

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

setDeprecated(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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.EnhancedParameterWrapper

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

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.

setEditable(boolean) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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.EnhancedParameterWrapper

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

Set the command-line reference to this parameter.

setExternalJavadocBaseUrls(List<URI>) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest

setExternalJavadocBaseUrls(List<URI>) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest

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

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.

setGoalPrefix(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setGoalPrefix(String) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator

setGroupId(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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.

setImplementation(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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.

setInheritedByDefault(boolean) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

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

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

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

setIntroducedDependencyArtifacts(Set<Artifact>) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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.

setMavenApiVersion(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest

setMavenProject(MavenProject) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

setMavenProject(MavenProject) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator

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

setMojoExecution(MojoExecution) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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.EnhancedParameterWrapper

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

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

Set the parameter name.

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

Deprecated.

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.

setPlugin(Plugin) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setPluginArtifact(Artifact) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setPluginContext(Map) - Method in class org.apache.maven.script.ant.AntMojoWrapper

Deprecated.

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.

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

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

Set a Repository Session

setRepository(ArtifactRepository) - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

setRequired(boolean) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

Set whether this parameter is required.

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

setRequiredJavaVersion(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

setRequiredMavenVersion(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setRequirement(Requirement) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

Deprecated.

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

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

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

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.

setSource(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

setSourceDirectories(List<File>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest

setType(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

Set the java type for this parameter.

setTypeJavadocUrl(URI) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

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

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

setV4Api(boolean) - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor

setV4Api(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

setVelocityComponent(VelocityComponent) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator

setVersion(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor

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

Refer to @since <deprecated-text>

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.artifact.repository.metadata.GroupRepositoryMetadata

storedInGroupDirectory() - Method in class org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata

T

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

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

threadSafe() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

threadSafe(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

toComponentDependencies(Collection<Artifact>) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils

toString() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

toString() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent

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

toString() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass

toString() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey

toString() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference

toString() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference

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

Deprecated.

Replaced by HtmlToPlainTextConverter

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

V4_API_ANNOTATIONS_PACKAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

V4_API_PLUGIN_PACKAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

validate(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor

validateParameter(Parameter, int) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor

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

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

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

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

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

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

valueOf(String) - Static method in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType

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

valueOf(String) - Static method in enum org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator.JavadocToolVersionRange

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

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

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

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

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

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

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

values() - Static method in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType

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

values() - Static method in enum org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator.JavadocToolVersionRange

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

ValueTagConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline

Supports inline value tag.

ValueTagConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.ValueTagConverter

visit(String, Object) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor

visit(int, int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

visitAnnotation(String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor

visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor

visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor

visitArray(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor

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

visitMethod(int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor

W

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

Method write.

write(OutputStream, 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, PluginDescriptorFilesGenerator.DescriptorType) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator

writeParameterType(XMLWriter, PluginDescriptorFilesGenerator.DescriptorType, JavadocLinkGenerator, Parameter, String) - Method in class org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator

Writes parameter type information and potentially also the related javadoc URL.

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