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

A

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
addMissingParameterSinceField(Parameter, PlexusConfiguration) - Method in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder: Reads the plugin descriptor and adds the fix for MNG-6109 when using Maven-3.3.9 and before.
append(StringBuilder, String, int) - Method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: Append a description to the buffer by respecting the indentSize and lineLength parameters.

B

build() - Method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
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
buildMavenProject(String) - Method in class org.apache.maven.plugin.plugin.report.PluginReport

C

canGenerateReport() - Method in class org.apache.maven.plugin.plugin.report.PluginReport
configuration - Variable in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder

D

DEFAULT_LINE_LENGTH - Static variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
descriptor - Variable in class org.apache.maven.plugin.plugin.report.GoalRenderer
detail - Variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: If true, display all settable properties for each goal.
disableInternalJavadocLinkValidation - Variable in class org.apache.maven.plugin.plugin.report.GoalRenderer
disableInternalJavadocLinkValidation - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: In case the internal javadoc site has not been generated when running this report goal (e.g.
discoverJdkRequirement(MavenProject, PluginDescriptor) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory: Tries to determine the JDK requirement from the following sources (until one is found) use JDK requirement from plugin descriptor use release configuration of org.apache.maven.plugins:maven-compiler-plugin use maven.compiler.release< property use target configuration of org.apache.maven.plugins:maven-compiler-plugin use maven.compiler.target property
discoverMavenRequirement(MavenProject, PluginDescriptor) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory: Tries to determine the Maven requirement from either the plugin descriptor or (if not set) from the Maven prerequisites element in the POM.
discoverRequirements(MavenProject) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
discoverVersions(String) - Method in class org.apache.maven.plugin.plugin.report.PluginReport

E

EnhancedPluginDescriptorBuilder - Class in org.apache.maven.plugins.plugin.descriptor: Reads enhanced plugin.xml files as generated by PluginDescriptorFilesGenerator and used by PluginReport.
EnhancedPluginDescriptorBuilder(boolean) - Constructor for class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
EnhancedPluginDescriptorBuilder(RuntimeInformation) - Constructor for class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
enhancedPluginXmlFile - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: Path to enhanced plugin descriptor to generate the report from (must contain some XHTML values)
execute() - Method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
executeReport(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
extractPluginDescriptor() - Method in class org.apache.maven.plugin.plugin.report.PluginReport

F

filterParameters(Collection<Parameter>) - Static method in class org.apache.maven.plugin.plugin.report.GoalRenderer: Filter parameters to only retain those which must be documented, i.e.
findNamedChild(Node, String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
findSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
format(String, Object) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer: Convenience method.
format(String, Object[]) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer: Looks up the value for key in the ResourceBundle, then formats that value for the specified Locale using args.

G

generateMojosDocumentation(PluginDescriptor, Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport: Generate the mojos' documentation with the AbstractMavenReport.getSinkFactory()
getCompilerPlugin(PluginContainer) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
getDescription(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
getI18nSection() - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
getI18nSection() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getI18nSection() - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
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
getI18nString(Locale, String) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
getIndentLevel(String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: Gets the indentation level of the specified line.
getJdk() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
getLinkedType(Parameter, boolean) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getMaven() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
getName(Locale) - Method in class org.apache.maven.plugin.plugin.report.PluginReport
getOutputName() - Method in class org.apache.maven.plugin.plugin.report.PluginReport
getPluginParameter(Plugin, String) - Static method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
getPropertyFromExpression(String) - Static method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getPropertyFromExpression(String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
getShortType(String) - Static method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getShortTypeOfSimpleType(String) - Static method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getShortTypeOfTypeArgument(String) - Static method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
getTitle() - Method in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
getTitle() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
getValue(Node, String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
getVersion() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
getXhtmlWithValidatedLinks(String, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
goal - Variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: The name of the goal for which to show help.
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

H

hasExtensionsToLoad - Variable in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
hasExtensionsToLoad - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: Set this to "true" to generate the usage section for "plugin-info.html" with <extensions>true</extensions>.
hasSameRequirements(RequirementsHistory) - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory
HelpMojo - Class in org.apache.maven.plugins.maven_plugin_report_plugin: Display help information on maven-plugin-report-plugin.
Call mvn plugin-report:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
HTML_LINK_PATTERN - Static variable in class org.apache.maven.plugin.plugin.report.GoalRenderer: Regular expression matching an XHTML link with group 1 = link target, group 2 = link label.

I

i18n - Variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
i18n - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: Internationalization component.
indentSize - Variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: The number of spaces per indentation level, should be positive.
isNotEmpty(String) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo

J

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

L

lineLength - Variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: The maximum length of a display line, should be positive.
locale - Variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
log - Variable in class org.apache.maven.plugin.plugin.report.GoalRenderer

M

maven - Variable in class org.apache.maven.plugin.plugin.report.RequirementsHistory: The minimum version of Maven to run this plugin.
mavenSession - Variable in class org.apache.maven.plugin.plugin.report.PluginReport

O

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

P

PLUGIN_HELP_PATH - Static variable in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
pluginDescriptor - Variable in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
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
PluginNoForkReport - Class in org.apache.maven.plugin.plugin.report: Generates the plugin's report: the plugin details page at plugin-info.html, and one goal-mojo.html per goal.
PluginNoForkReport(RuntimeInformation, I18N, MavenSession, RepositorySystem, ProjectBuilder) - Constructor for class org.apache.maven.plugin.plugin.report.PluginNoForkReport
PluginOverviewRenderer - Class in org.apache.maven.plugin.plugin.report: Generates an overview page with the list of goals and a link to the goal's page.
PluginOverviewRenderer(Sink, I18N, Locale, MavenProject, List<RequirementsHistory>, PluginDescriptor, boolean) - Constructor for class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
PluginReport - Class in org.apache.maven.plugin.plugin.report: Generates the plugin's report: the plugin details page at plugin-info.html and one goal-mojo.html per goal.
PluginReport(RuntimeInformation, I18N, MavenSession, RepositorySystem, ProjectBuilder) - Constructor for class org.apache.maven.plugin.plugin.report.PluginReport
project - Variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
projectBuilder - Variable in class org.apache.maven.plugin.plugin.report.PluginReport

R

renderAttribute(boolean, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderAttribute(boolean, String, Optional<String>) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderAttribute(String, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderAttributes() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderBody() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderBody() - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
renderDeprecatedParameterDescription(String, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderDescription(String, String, boolean) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer: A description consists of a term/prefix and the actual description text
renderDescriptionPrefix(String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderDetail(String, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderDetail(String, String, Optional<String>) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderGoalsSection(boolean) - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
renderParameterDetails(Iterator<Parameter>) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderParameterOverviewTable(String, Iterator<Parameter>) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderParameterOverviewTableRow(Parameter) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderReportNotice() - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderRequirementsHistoriesSection() - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
renderSystemRequirementsSection() - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
renderTableCellDetail(String, String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderTableCellWithCode(String) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderTableCellWithCode(String, Optional<String>) - Method in class org.apache.maven.plugin.plugin.report.GoalRenderer
renderUsageSection(boolean) - Method in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer: Render the section about the usage of the plugin.
repeat(String, int) - Static method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo: Repeat a String n times to form a new string.
reportOutputDirectory - Variable in class org.apache.maven.plugin.plugin.report.GoalRenderer: The directory where the generated site is written.
repositorySystem - Variable in class org.apache.maven.plugin.plugin.report.PluginReport
requireAddingMissingParameterSinceField - Variable in class org.apache.maven.plugins.plugin.descriptor.EnhancedPluginDescriptorBuilder
requirementsHistories - Variable in class org.apache.maven.plugin.plugin.report.PluginOverviewRenderer
requirementsHistories - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: The Plugin requirements history list.
RequirementsHistory - Class in org.apache.maven.plugin.plugin.report: Plugin requirements history.
RequirementsHistory() - Constructor for class org.apache.maven.plugin.plugin.report.RequirementsHistory
requirementsHistoryDetectionRange - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: Plugin's version range for automatic detection of requirements history.
RESOURCE_BASENAME - Static variable in class org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
rtInfo - Variable in class org.apache.maven.plugin.plugin.report.PluginReport

S

skip - Variable in class org.apache.maven.plugin.plugin.report.PluginReport: Set this to "true" to skip generating the report.

T

toLines(String, int, int, int) - Static method in class org.apache.maven.plugins.maven_plugin_report_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.plugins.maven_plugin_report_plugin.HelpMojo: Adds the specified line to the output sequence, performing line wrapping if necessary.
toString() - Method in class org.apache.maven.plugin.plugin.report.RequirementsHistory

V

version - Variable in class org.apache.maven.plugin.plugin.report.RequirementsHistory: The plugin version.

W

writeGoal(StringBuilder, String, Element) - Method in class org.apache.maven.plugins.maven_plugin_report_plugin.HelpMojo
writeParameter(StringBuilder, Node, Node) - Method in class org.apache.maven.plugins.maven_plugin_report_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