Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractScriptedMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor
-
Deprecated.Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0
- AbstractScriptedMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.
C
- clone() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- compare(MojoDescriptorExtractor, MojoDescriptorExtractor) - Method in class org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator
- 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
- 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. - 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(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.
D
- 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
- 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
E
- 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
- equals(Object) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.Execute the mojo extraction.
- execute(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Execute the mojo extraction.
- ExtendedMojoDescriptor - Class in org.apache.maven.tools.plugin
-
Extensions to MojoDescriptor added to Maven 3, then are not available when run under Maven2.
- ExtendedMojoDescriptor() - Constructor for class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
- ExtendedMojoDescriptor(boolean) - Constructor for class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
- ExtractionException - Exception in org.apache.maven.tools.plugin.extractor
-
Wrap errors when extraction exception occurred.
- ExtractionException(String) - Constructor for exception org.apache.maven.tools.plugin.extractor.ExtractionException
- ExtractionException(String, Throwable) - Constructor for exception org.apache.maven.tools.plugin.extractor.ExtractionException
- extractMojoDescriptors(Map<String, Set<File>>, PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
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
- 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.
- getAlias() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getClassName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference
- getDefaultValue() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getDependencies() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getDependencies() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
-
Returns the list of
Artifact
used in class path scanning for annotations - getDependencyCollectionRequired() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
- getDeprecated() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getDescription() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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.
- 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
- getFullyQualifiedClassName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference
- getGroup() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey
-
Returns the group this key belongs to, never
null
. - 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. - getImplementation() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getInternalJavadocBaseUrl() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getInternalJavadocBaseUrl() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- 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
- getLabel() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference
- getLocal() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getLocal() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- 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 class org.apache.maven.tools.plugin.javadoc.JavadocReference
- getName() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getName() - Method in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
-
Returns the "name" (id) of the extractor.
- getOrder() - Method in class org.apache.maven.tools.plugin.extractor.GroupKey
-
Returns the order within same group of this key.
- getPackageName() - Method in class org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference
- getPackageNameClassName() - Method in class org.apache.maven.tools.plugin.javadoc.JavadocReference
- getPluginDescriptor() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getPluginDescriptor() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- getProject() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getProject() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- getRemoteRepos() - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- getRemoteRepos() - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- getRequirement() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- getType() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- getTypeJavadocUrl() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
H
- hashCode() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
I
- INSTANCE - Static variable in class org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator
- isDeprecated() - Method in class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
-
Deprecated.
- 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
- isLinkValid(URI, Path) - Static method in class org.apache.maven.tools.plugin.javadoc.JavadocLinkGenerator
-
Checks if a given link is valid.
- 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
- isThreadSafe() - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
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.
- 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
. - 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
M
- MAVEN_COMPONENTS - Static variable in class org.apache.maven.tools.plugin.util.PluginUtils
-
Deprecated.wrong approach (fake components), documented parameter default values instead to learn people how to discover them
- METHOD - Enum constant in enum org.apache.maven.tools.plugin.javadoc.FullyQualifiedJavadocReference.MemberType
- 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
- MojoScanner - Interface in org.apache.maven.tools.plugin.scanner
O
- 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.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
P
- parse(String) - Static method in class org.apache.maven.tools.plugin.javadoc.JavadocReference
- 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.
- populatePluginDescriptor(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.scanner.DefaultMojoScanner
- populatePluginDescriptor(PluginToolsRequest) - Method in interface org.apache.maven.tools.plugin.scanner.MojoScanner
S
- 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
- 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 interface org.apache.maven.tools.plugin.PluginToolsRequest
- setDependencyCollectionRequired(String) - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
- setDeprecated(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- setDescription(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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.
- 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
- setImplementation(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- setLocal(ArtifactRepository) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- setLocal(ArtifactRepository) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- setName(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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 interface org.apache.maven.tools.plugin.PluginToolsRequest
- setRemoteRepos(List<ArtifactRepository>) - Method in class org.apache.maven.tools.plugin.DefaultPluginToolsRequest
- setRemoteRepos(List<ArtifactRepository>) - Method in interface org.apache.maven.tools.plugin.PluginToolsRequest
- setRequired(boolean) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- setRequirement(Requirement) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
- 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.
- setThreadSafe(boolean) - Method in class org.apache.maven.tools.plugin.ExtendedMojoDescriptor
- setType(String) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- setTypeJavadocUrl(URI) - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- sortMojoParameters(List<Parameter>) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils
-
Sorts the specified mojo parameters by name.
- sortMojos(List<MojoDescriptor>) - Static method in class org.apache.maven.tools.plugin.util.PluginUtils
-
Sorts the specified mojo descriptors by goal name.
T
- toString() - Method in class org.apache.maven.tools.plugin.EnhancedParameterWrapper
- 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
V
- 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.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.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form