Package org.apache.maven.plugin.plugin.report

Class AbstractPluginReportRenderer

  • All Implemented Interfaces:
    org.apache.maven.reporting.MavenReportRenderer
    Direct Known Subclasses:
    GoalRenderer, PluginOverviewRenderer
    public abstract class AbstractPluginReportRenderer
extends org.apache.maven.reporting.AbstractMavenReportRenderer
    Base class for all reports generated by the plugin report plugin.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.codehaus.plexus.i18n.I18N i18n  
      protected java.util.Locale locale  
      protected org.apache.maven.project.MavenProject project  
      private static java.lang.String RESOURCE_BASENAME  

      • Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

        sink

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractPluginReportRenderer​(org.apache.maven.doxia.sink.Sink sink, java.util.Locale locale, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.project.MavenProject project)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract java.lang.String getI18nSection()  
      protected java.lang.String getI18nString​(java.lang.String key)
      Returns
      protected java.lang.String getI18nString​(java.lang.String section, java.lang.String key)  
      java.lang.String getTitle()  

      • Methods inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

        createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, renderBody, startSection, startSection, startTable, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimSource, verbatimText

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • RESOURCE_BASENAME

        private static final java.lang.String RESOURCE_BASENAME
        See Also:
        Constant Field Values

      • i18n

        private final org.codehaus.plexus.i18n.I18N i18n

      • locale

        protected final java.util.Locale locale

      • project

        protected final org.apache.maven.project.MavenProject project

    • Constructor Detail

      • AbstractPluginReportRenderer

        protected AbstractPluginReportRenderer​(org.apache.maven.doxia.sink.Sink sink,
                                       java.util.Locale locale,
                                       org.codehaus.plexus.i18n.I18N i18n,
                                       org.apache.maven.project.MavenProject project)

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Specified by:
        getTitle in interface org.apache.maven.reporting.MavenReportRenderer
        Specified by:
        getTitle in class org.apache.maven.reporting.AbstractMavenReportRenderer

      • getI18nString

        protected java.lang.String getI18nString​(java.lang.String key)
        Returns
        Parameters:
        key - The key .
        Returns:
        The translated string.

      • getI18nString

        protected java.lang.String getI18nString​(java.lang.String section,
                                         java.lang.String key)
        Parameters:
        section - The section.
        key - The key to translate.
        Returns:
        the translated key.

      • getI18nSection

        protected abstract java.lang.String getI18nSection()
        Returns:
        the key prefix to be used with every key. Is prepended by report..