Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractGeneratorMojo - Class in org.apache.maven.plugin.plugin
-
Abstract class for this Plugin.
- AbstractGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
- 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.
- addMojo(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- addMojos(List<MojoDescriptor>) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- 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() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
if the Mojo uses the Maven project and its child modules.
- aggregator() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- aggregator(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- alias() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
alias supported to get parameter value.
- alias() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- alias(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- analyzeVisitors(MojoClassVisitor) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
- AnnotatedContent - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
- AnnotatedContent() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedContent
- AnnotatedField - Class in org.apache.maven.tools.plugin.extractor.annotations.datamodel
- AnnotatedField(String) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.AnnotatedField
- annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
- annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- annotationType() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
B
- build(Reader) - Method in class org.apache.maven.plugins.plugin.descriptor.PluginDescriptorBuilder
- build(Reader, String) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
- build(Reader, String) - Method in class org.apache.maven.plugins.plugin.descriptor.PluginDescriptorBuilder
- buildComponentDescriptor(PlexusConfiguration, PluginDescriptor) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
- buildComponentDescriptor(PlexusConfiguration, PluginDescriptor) - Method in class org.apache.maven.plugins.plugin.descriptor.PluginDescriptorBuilder
- buildConfiguration(Reader) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
-
Cache the returned configuration for additional evaluation in
EnhancedPluginDescriptorBuilder.build(Reader, String)
. - buildConfiguration(Reader) - Method in class org.apache.maven.plugins.plugin.descriptor.PluginDescriptorBuilder
- 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
- CLEAN - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- 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 toGroupKey.JAVA_GROUP
, is always first, other groups are in natural order (string) within same named groups, order is defined byGroupKey.order
- COMPILE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- COMPILE - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
compile
resolution scope =compile
+system
+provided
dependencies - COMPILE_PLUS_RUNTIME - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
compile+runtime
resolution scope (Maven 3 only) =compile
+system
+provided
+runtime
dependencies - Component - Annotation Type in org.apache.maven.plugins.annotations
-
Used to configure injection of Plexus components by
MavenPluginManager.getConfiguredMojo(...)
. - COMPONENT_V3 - 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() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
own configurator class.
- configurator() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- configurator(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- CONSTRUCTOR - Enum constant in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType
- containsXhtmlTextValues() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
-
Indicates if the methods
ComponentDescriptor.getDescription()
,MojoDescriptor.getDeprecated()
,Parameter.getDescription()
andParameter.getDeprecated()
return XHTML values. - convert(DocletTag, ConverterContext) - Method in class org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter
- convert(String) - Method in interface org.apache.maven.tools.plugin.generator.Converter
- convert(String) - Method in class org.apache.maven.tools.plugin.generator.HtmlToPlainTextConverter
- 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
- 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
andJavadocBlockTagToHtmlConverter
. - copyScriptsToOutputDirectory(Map<String, Set<File>>, String, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.
- 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.
- 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.
- customPhase() - Element in annotation type org.apache.maven.plugins.annotations.Execute
-
Custom lifecycle phase to fork.
- 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() - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
-
Empty constructor
- DefaultMojoScanner(Map<String, MojoDescriptorExtractor>) - Constructor for class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
-
Default constructor
- defaultPhase() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
default phase to bind your mojo.
- defaultPhase() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- defaultPhase(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- DefaultPluginToolsRequest - Class in org.apache.maven.tools.plugin
-
Default implementation of
PluginToolsRequest
, which is used to pass parameters to components used to extractMojoDescriptor
instances from different types of metadata for a given plugin. - DefaultPluginToolsRequest(MavenProject, PluginDescriptor) - Constructor for class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- defaultValue() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
parameter default value, may contain
${...}
expressions which will be interpreted at inject time: see PluginParameterExpressionEvaluator. - defaultValue() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- defaultValue(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- dependencyResolutionRequired(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- DEPLOY - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- 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
- 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 oforg.apache.maven.plugins:maven-compiler-plugin
usemaven.compiler.release<
property usetarget
configuration oforg.apache.maven.plugins:maven-compiler-plugin
usemaven.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
- 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 byPluginReport
. - 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() - 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(File) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
- 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(MavenProject, String) - Static method in class org.apache.maven.plugin.plugin.metadata.LegacySupport
- 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(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Execute the mojo extraction.
- Execute - Annotation Type in org.apache.maven.plugins.annotations
-
Used if your Mojo needs to fork a lifecycle.
- 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
- executionStrategy() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- executionStrategy() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- executionStrategy(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- ExtendedMojoDescriptor - Class in org.apache.maven.tools.plugin
-
Extensions to
MojoDescriptor
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 Class in org.apache.maven.tools.plugin.extractor
-
Wrap errors when extraction exception occurred.
- ExtractionException(String) - Constructor for exception class org.apache.maven.tools.plugin.extractor.ExtractionException
- ExtractionException(String, Throwable) - Constructor for exception class 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.
- extractMojoDescriptorsFromMetadata(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.Should be implemented in the sub classes.
F
- FIELD - Enum constant in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType
- 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
andlinkplain
. - FullyQualifiedJavadocReference(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>, 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
- GENERATE_RESOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_SOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_TEST_RESOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- GENERATE_TEST_SOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- Generator - Interface in org.apache.maven.tools.plugin.generator
-
Generate something, for instance a plugin report, from a plugin descriptor.
- GeneratorException - Exception Class in org.apache.maven.tools.plugin.generator
- GeneratorException(String, Throwable) - Constructor for exception class org.apache.maven.tools.plugin.generator.GeneratorException
- GeneratorUtils - Class in org.apache.maven.tools.plugin.generator
-
Convenience methods to play with Maven plugins.
- getAlias() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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
- 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
- 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
- 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
- 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(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
- 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
- getExpression() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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 interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Returns the
GroupKey
of extractor, asMojoScanner
will execute them grouped, and ordered within groups. - 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
- 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
- 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
- getMember() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference
- getMemberType() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference
- getMetadataFileExtension(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.Should be implemented in the sub classes.
- 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() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- getMojo(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- getMojoAnnotatedClass() - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
- getMojos() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- 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 interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Returns the "name" (id) of the extractor.
- getName(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
- getOrder() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey
-
Returns the order within same group of this key.
- 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
- 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
- getPlugin() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- getPluginArtifact() - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- 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
- 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
- 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.
- 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
- 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
- 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() - Element in annotation type org.apache.maven.plugins.annotations.Execute
-
Goal to fork.
- goal() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- goal(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- 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.
Callmvn plugin:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo - Class in org.apache.maven.plugins.maven_plugin_report_plugin
-
Display help information on maven-plugin-report-plugin.
Callmvn plugin-report:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class org.apache.maven.plugins.maven_plugin_plugin.HelpMojo
- HelpMojo() - Constructor for class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
- hint() - Element in annotation type org.apache.maven.plugins.annotations.Component
-
hint of the component to inject.
- hint() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
- hint(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
- 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
- inheritByDefault() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- inheritByDefault() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- inheritByDefault(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- INITIALIZE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- INSTALL - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- INSTANCE - Static variable in class org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator
- instantiationStrategy() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
your Mojo instantiation strategy.
- instantiationStrategy() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- instantiationStrategy(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- InstantiationStrategy - Enum in org.apache.maven.plugins.annotations
-
Component instantiation strategy.
- INTEGRATION_TEST - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- 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. - 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 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
- 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
- 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
- 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
- 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(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(List<URI>, Settings) - Constructor for class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator
-
Constructor for online external sites only.
- JavadocLinkGenerator.JavadocToolVersionRange - Enum in org.apache.maven.tools.plugin.javadoc
-
Javadoc tool version ranges whose generated sites expose different link formats.
- JavadocReference - Class in org.apache.maven.tools.plugin.javadoc
-
Describes a code reference used in javadoc tags
see
,link
andlinkplain
. - JavadocTagToHtmlConverter - Class in org.apache.maven.tools.plugin.extractor.annotations.converter.tag
-
Common base class of both
JavadocBlockTagToHtmlConverter
andJavadocInlineTagToHtmlConverter
. - JavadocTagToHtmlConverter() - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter
- JDK10_OR_HIGHER - Enum constant in enum org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator.JavadocToolVersionRange
- JDK7_OR_LOWER - Enum constant in enum org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator.JavadocToolVersionRange
- JDK8_OR_9 - Enum constant in enum org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator.JavadocToolVersionRange
K
- KEEP_ALIVE - Enum constant in enum org.apache.maven.plugins.annotations.InstantiationStrategy
L
- LegacySupport - Class in org.apache.maven.plugin.plugin.metadata
- LegacySupport() - Constructor for class org.apache.maven.plugin.plugin.metadata.LegacySupport
- lifecycle() - Element in annotation type org.apache.maven.plugins.annotations.Execute
-
Lifecycle id of the lifecycle that defines
Execute.phase()
. - lifecycle() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- lifecycle(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- LifecyclePhase - Enum in org.apache.maven.plugins.annotations
- 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 - Enum constant in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType
- 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_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
byMojoDescriptorExtractor.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
- MVN4_API - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
N
- name() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
goal name (required).
- name() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
name of the bean property used to get/set the field: by default, field name is used.
- name() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- name() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- name(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- name(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- NAME - Static variable in class org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor
- NONE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- NONE - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
empty resolution scope
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.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.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
- PACKAGE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- Parameter - Annotation Type in org.apache.maven.plugins.annotations
-
Used to configure your Mojo parameters to be injected by
MavenPluginManager.getConfiguredMojo(...)
. - 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, String, String, boolean, boolean, String, List<String>, boolean) - Constructor for class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- ParameterAnnotationContent(String, 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
- PER_LOOKUP - Enum constant in enum org.apache.maven.plugins.annotations.InstantiationStrategy
- phase() - Element in annotation type org.apache.maven.plugins.annotations.Execute
-
Lifecycle phase to fork.
- phase() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- phase(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent
- PluginDescriptorBuilder - Class in org.apache.maven.plugins.plugin.descriptor
-
Build plugin descriptor object from
plugin.xml
. - PluginDescriptorBuilder() - Constructor for class org.apache.maven.plugins.plugin.descriptor.PluginDescriptorBuilder
- 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) fororg.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 fromhelp-class-source.vm
template. - PluginHelpGenerator() - Constructor for class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
-
Default constructor
- PluginReport - Class in org.apache.maven.plugin.plugin.report
-
Generates the Plugin's documentation report:
plugin-info.html
plugin overview page, and onegoal-mojo.html
per goal. - PluginReport() - Constructor for class org.apache.maven.plugin.plugin.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.
- POOLABLE - Enum constant in enum org.apache.maven.plugins.annotations.InstantiationStrategy
- 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
- POST_CLEAN - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- POST_INTEGRATION_TEST - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- POST_SITE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_CLEAN - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_INTEGRATION_TEST - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PRE_SITE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PREPARE_PACKAGE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_CLASSES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_RESOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_SOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_CLASSES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_RESOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- PROCESS_TEST_SOURCES - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- processMojoDescriptor(MojoDescriptor, XMLWriter, PluginDescriptorFilesGenerator.DescriptorType, JavadocLinkGenerator, boolean) - 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
- projectRequired(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- property() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
Property to use to retrieve a value.
- property() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- property(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
R
- readonly() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
- readonly() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- readonly(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- renderBody() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
- required() - Element in annotation type org.apache.maven.plugins.annotations.Parameter
-
is the parameter required?
- required() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- required(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent
- RequirementsHistory - Class in org.apache.maven.plugin.plugin.report
-
Plugin requirements history.
- RequirementsHistory() - Constructor for class org.apache.maven.plugin.plugin.report.RequirementsHistory
- requiresDependencyCollection() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
the required dependency collection scope.
- requiresDependencyCollection() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresDependencyCollection(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresDependencyResolution() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
the required dependency resolution scope.
- requiresDependencyResolution() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresDependencyResolution(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresDirectInvocation() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- requiresDirectInvocation() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresDirectInvocation(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresOnline() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
does this Mojo need to be online to be executed?
- requiresOnline() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresOnline(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresProject() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
does your mojo requires a project to be executed?
- requiresProject() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresProject(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresReports() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
Deprecated.unused
- requiresReports() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- requiresReports(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- ResolutionScope - Enum 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() - Element in annotation type org.apache.maven.plugins.annotations.Component
-
role of the component to inject.
- role() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
- ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
- RUNTIME - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
runtime
resolution scope =compile
+runtime
dependencies - RUNTIME_PLUS_SYSTEM - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
runtime+system
resolution scope (Maven 3 only) =compile
+system
+runtime
dependencies
S
- scan(Map<String, MojoAnnotatedClass>, File, List<String>, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
- scan(MojoAnnotationsScannerRequest) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
- scan(MojoAnnotationsScannerRequest) - Method in interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
-
Scan classes for mojo annotations.
- scanArchive(File, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
- scanDirectory(File, List<String>, Artifact, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner
- 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.
- setAlias(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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
- setComponents(Map<String, ComponentAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- setDefaultValue(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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
- 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
- setExpression(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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
- 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
- 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
- setMavenApiVersion(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScannerRequest
- setMavenProject(MavenProject) - Method in class org.apache.maven.tools.plugin.generator.PluginHelpGenerator
- setMojo(MojoAnnotationContent) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- setName(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- setName(String) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- setParameters(Map<String, ParameterAnnotationContent>) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- setParentClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotatedClass
- setPlugin(Plugin) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- setPluginArtifact(Artifact) - Method in class org.apache.maven.tools.plugin.ExtendedPluginDescriptor
- 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
- 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
- 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
- setRoleClassName(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent
- 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
- 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
- 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
- SINGLETON - Enum constant in enum org.apache.maven.plugins.annotations.InstantiationStrategy
- SITE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- SITE_DEPLOY - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- 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
- TEST - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- TEST - Enum constant in enum org.apache.maven.plugins.annotations.ResolutionScope
-
test
resolution scope =compile
+system
+provided
+runtime
+test
dependencies - TEST_COMPILE - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- threadSafe() - Element in annotation type org.apache.maven.plugins.annotations.Mojo
-
is your mojo thread safe (since Maven 3.x)?
- threadSafe() - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- threadSafe(boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent
- toComponentDependencies(Collection<Artifact>) - Static method in class org.apache.maven.tools.plugin.generator.GeneratorUtils
- toString() - Method in class org.apache.maven.plugin.plugin.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
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 - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- 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
- VERIFY - Enum constant in enum org.apache.maven.plugins.annotations.LifecyclePhase
- visit(int, int, String, String, String, String[]) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
- visit(String, Object) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
- visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor
- visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor
- visitAnnotation(String, boolean) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoMethodVisitor
- visitAnnotation(String, String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
- visitArray(String) - Method in class org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor
- 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
- 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.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form