Index

A B C D E F G H I J L M O P R S T V W 
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
 
addOther(String, String) - Method in class org.apache.maven.plugin.plugin.Requirements
Method addOther.
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
 
append(StringBuilder, String, int) - Method in class org.apache.maven.plugin.plugin.HelpMojo
Append a description to the buffer by respecting the indentSize and lineLength parameters.

B

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

C

canGenerateReport() - Method in class org.apache.maven.plugin.plugin.PluginReport
createGenerator() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
 
createGenerator() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
createGenerator() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo

D

DEFAULT_LINE_LENGTH - Static variable in class org.apache.maven.plugin.plugin.HelpMojo
 
dependencies - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The set of dependencies for the current project
dependencies - Variable in class org.apache.maven.plugin.plugin.PluginReport
The set of dependencies for the current project
DescriptorGeneratorMojo - Class in org.apache.maven.plugin.plugin
Generate a plugin descriptor.
DescriptorGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
 
detail - Variable in class org.apache.maven.plugin.plugin.HelpMojo
If true, display all settable properties for each goal.
discoverJdkRequirement(MavenProject, Requirements) - Static method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
use configured jdk requirement use target configuration of org.apache.maven.plugins:maven-compiler-plugin use target configuration of org.apache.maven.plugins:maven-compiler-plugin in pluginManagement use maven.compiler.target property
discoverMavenRequirement(MavenProject, Requirements) - Static method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
Try to lookup on the Maven prerequisites property.
diskSpace - Variable in class org.apache.maven.plugin.plugin.Requirements
The minimum diskSpace needed to run this plugin.

E

encoding - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The file encoding of the source files.
encoding - Variable in class org.apache.maven.plugin.plugin.PluginReport
The file encoding of the source files.
equals(Object) - Method in class org.apache.maven.plugin.plugin.Requirements
Method equals.
execute() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
execute() - Method in class org.apache.maven.plugin.plugin.HelpMojo
execute() - Method in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
executeReport(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
extractors - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The role names of mojo extractors to use.
extractPluginDescriptor() - Method in class org.apache.maven.plugin.plugin.PluginReport
 

F

filterMojoDependencies() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
Get dependencies filtered with mojoDependencies configuration.
findNamedChild(Node, String) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
findSingleChild(Node, String) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 

G

generateMojosDocumentation(PluginDescriptor, Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
Generate the mojos documentation, as xdoc files.
getBundle(Locale) - Static method in class org.apache.maven.plugin.plugin.PluginReport
 
getCompilerPlugin(Map<String, Plugin>) - Static method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
getDescription(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
getDiskSpace() - Method in class org.apache.maven.plugin.plugin.Requirements
Get the minimum diskSpace needed to run this plugin.
getGoalPrefix() - Method in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
 
getIndentLevel(String) - Static method in class org.apache.maven.plugin.plugin.HelpMojo
Gets the indentation level of the specified line.
getJdk() - Method in class org.apache.maven.plugin.plugin.Requirements
Get the minimum version of the JDK to run this plugin.
getMaven() - Method in class org.apache.maven.plugin.plugin.Requirements
Get the minimum version of Maven to run this plugin.
getMemory() - Method in class org.apache.maven.plugin.plugin.Requirements
Get the minimum memory needed to run this plugin.
getName(Locale) - Method in class org.apache.maven.plugin.plugin.PluginReport
getOthers() - Method in class org.apache.maven.plugin.plugin.Requirements
Method getOthers.
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
 
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
getOutputDirectory() - Method in class org.apache.maven.plugin.plugin.PluginReport
getOutputName() - Method in class org.apache.maven.plugin.plugin.PluginReport
getPluginDescriptorBuilder() - Method in class org.apache.maven.plugin.plugin.PluginReport
Return the pluginDescriptorBuilder to use based on the Maven version: either use the original from the maven-plugin-api or a patched version for Maven versions before the MNG-6109 fix (because of Maven MNG-6109 bug that won't give accurate 'since' info when reading plugin.xml).
getPluginParameter(Plugin, String) - Static method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
getProject() - Method in class org.apache.maven.plugin.plugin.PluginReport
getPropertyFromExpression(String) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
getSingleChild(Node, String) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
getSiteRenderer() - Method in class org.apache.maven.plugin.plugin.PluginReport
getTitle() - Method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
getValue(Node, String) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
goal - Variable in class org.apache.maven.plugin.plugin.HelpMojo
The name of the goal for which to show help.
goalPrefix - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The goal prefix that will appear before the ":".
goalPrefix - Variable in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
The prefix for the plugin goal.
goalPrefix - Variable in class org.apache.maven.plugin.plugin.PluginReport
The goal prefix that will appear before the ":".

H

hashCode() - Method in class org.apache.maven.plugin.plugin.Requirements
Method hashCode.
HelpGeneratorMojo - Class in org.apache.maven.plugin.plugin
Generates a HelpMojo class.
HelpGeneratorMojo() - Constructor for class org.apache.maven.plugin.plugin.HelpGeneratorMojo
 
HelpMojo - Class in org.apache.maven.plugin.plugin
Display help information on maven-plugin-plugin.
Call mvn plugin:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.maven.plugin.plugin.HelpMojo
 
helpPackageName - Variable in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
The name of the package for the generated HelpMojo.

I

indentSize - Variable in class org.apache.maven.plugin.plugin.HelpMojo
The number of spaces per indentation level, should be positive.
isNotEmpty(String) - Static method in class org.apache.maven.plugin.plugin.HelpMojo
 

J

jdk - Variable in class org.apache.maven.plugin.plugin.Requirements
The minimum version of the JDK to run this plugin.

L

lineLength - Variable in class org.apache.maven.plugin.plugin.HelpMojo
The maximum length of a display line, should be positive.
local - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
Location of the local repository.
local - Variable in class org.apache.maven.plugin.plugin.PluginReport
Location of the local repository.
locale - Variable in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 

M

maven - Variable in class org.apache.maven.plugin.plugin.Requirements
The minimum version of Maven to run this plugin.
memory - Variable in class org.apache.maven.plugin.plugin.Requirements
The minimum memory needed to run this plugin.
MNG6109PluginDescriptorBuilder - Class in org.apache.maven.plugins.plugin.descriptor
Reads the plugin descriptor and adds the fix for MNG-6109 when using Maven-3.3.9 and before.
MNG6109PluginDescriptorBuilder() - Constructor for class org.apache.maven.plugins.plugin.descriptor.MNG6109PluginDescriptorBuilder
 
mojoDependencies - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
Specify the dependencies as groupId:artifactId containing (abstract) Mojos, to filter dependencies scanned at runtime and focus on dependencies that are really useful to Mojo analysis.
mojoScanner - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The component used for scanning the source tree for mojos.
mojoScanner - Variable in class org.apache.maven.plugin.plugin.PluginReport
Mojo scanner tools.

O

org.apache.maven.plugin.plugin - package org.apache.maven.plugin.plugin
 
org.apache.maven.plugin.plugin.metadata - package org.apache.maven.plugin.plugin.metadata
 
org.apache.maven.plugins.plugin.descriptor - package org.apache.maven.plugins.plugin.descriptor
 
others - Variable in class org.apache.maven.plugin.plugin.Requirements
Field others.
outputDirectory - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
The directory where the generated plugin.xml file will be put.
outputDirectory - Variable in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
The directory where the generated HelpMojo file will be put.
outputDirectory - Variable in class org.apache.maven.plugin.plugin.PluginReport
Report output directory for mojos' documentation.

P

packagingTypes - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
Maven plugin packaging types.
PLUGIN_HELP_PATH - Static variable in class org.apache.maven.plugin.plugin.HelpMojo
 
pluginDescriptor - Variable in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
PluginOverviewRenderer(MavenProject, Requirements, Sink, PluginDescriptor, Locale) - Constructor for class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
PluginReport - Class in org.apache.maven.plugin.plugin
Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal.
PluginReport() - Constructor for class org.apache.maven.plugin.plugin.PluginReport
 
PluginReport.PluginOverviewRenderer - Class in org.apache.maven.plugin.plugin
Generates an overview page with the list of goals and a link to the goal's page.
pluginXmlFile - Variable in class org.apache.maven.plugin.plugin.PluginReport
Path to plugin.xml plugin descriptor to generate the report from.
project - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
The project currently being built.
project - Variable in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
The project artifact, which should have the latest metadata added to it.
project - Variable in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
project - Variable in class org.apache.maven.plugin.plugin.PluginReport
The Maven Project.

R

remoteRepos - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
List of Remote Repositories used by the resolver
remoteRepos - Variable in class org.apache.maven.plugin.plugin.PluginReport
List of Remote Repositories used by the resolver
renderBody() - Method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
renderUsageSection(boolean) - Method in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
Render the section about the usage of the plugin.
repeat(String, int) - Static method in class org.apache.maven.plugin.plugin.HelpMojo
Repeat a String n times to form a new string.
requirements - Variable in class org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
 
requirements - Variable in class org.apache.maven.plugin.plugin.PluginReport
Specify some requirements to execute this plugin.
Requirements - Class in org.apache.maven.plugin.plugin
Plugin requirements.
Requirements() - Constructor for class org.apache.maven.plugin.plugin.Requirements
 
rtInfo - Variable in class org.apache.maven.plugin.plugin.PluginReport
 

S

setDiskSpace(String) - Method in class org.apache.maven.plugin.plugin.Requirements
Set the minimum diskSpace needed to run this plugin.
setJdk(String) - Method in class org.apache.maven.plugin.plugin.Requirements
Set the minimum version of the JDK to run this plugin.
setMaven(String) - Method in class org.apache.maven.plugin.plugin.Requirements
Set the minimum version of Maven to run this plugin.
setMemory(String) - Method in class org.apache.maven.plugin.plugin.Requirements
Set the minimum memory needed to run this plugin.
setOthers(Properties) - Method in class org.apache.maven.plugin.plugin.Requirements
Set others requirements properties.
siteRenderer - Variable in class org.apache.maven.plugin.plugin.PluginReport
Doxia Site Renderer.
skip - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
Set this to "true" to skip invoking any goals or reports of the plugin.
skip - Variable in class org.apache.maven.plugin.plugin.metadata.AddPluginArtifactMetadataMojo
Set this to "true" to skip invoking any goals or reports of the plugin.
skip - Variable in class org.apache.maven.plugin.plugin.PluginReport
Set this to "true" to skip invoking any goals or reports of the plugin.
skipDescriptor - Variable in class org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
A flag to disable generation of the plugin.xml in favor of a hand authored plugin descriptor.
skipErrorNoDescriptorsFound - Variable in class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
By default an exception is throw if no mojo descriptor is found.
skipReport - Variable in class org.apache.maven.plugin.plugin.PluginReport
Set this to "true" to skip generating the report.

T

toLines(String, int, int, int) - Static method in class org.apache.maven.plugin.plugin.HelpMojo
Splits the specified text into lines of convenient display length.
toLines(List<String>, String, int, int) - Static method in class org.apache.maven.plugin.plugin.HelpMojo
Adds the specified line to the output sequence, performing line wrapping if necessary.
toString() - Method in class org.apache.maven.plugin.plugin.Requirements
Method toString.

V

velocity - Variable in class org.apache.maven.plugin.plugin.HelpGeneratorMojo
Velocity component.

W

writeGoal(StringBuilder, String, Element) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
writeParameter(StringBuilder, Node, Node) - Method in class org.apache.maven.plugin.plugin.HelpMojo
 
A B C D E F G H I J L M O P R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form