Package org.codehaus.mojo.l10n

Class L10NStatusReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.l10n.L10NStatusReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
@Mojo(name="report") public class L10NStatusReport extends org.apache.maven.reporting.AbstractMavenReport
A simple report for keeping track of l10n status. It lists all bundle properties files and the number of properties in them. For a configurable list of locales it also tracks the progress of localization.
Since:
1.0.0
Author:
Milos Kleint

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    aggregate
    Whether to build an aggregated report at the root, or build individual reports.

    Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

    locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    L10NStatusReport()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    protected Map<org.apache.maven.project.MavenProject,List<org.apache.maven.model.Resource>>
    constructResourceDirs()
    Collects resource definitions from all projects in reactor.
    protected void
    executeReport(Locale locale)
     
    String
    getDescription(Locale locale)
     
    String
    getName(Locale locale)
     
    String
    getOutputName()
     

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.maven.reporting.MavenReport

    getOutputPath

  • Field Details

    • aggregate

      @Parameter(defaultValue="false", property="maven.l10n.aggregate") protected boolean aggregate
      Whether to build an aggregated report at the root, or build individual reports.
      Since:
      1.0.0

  • Constructor Details

    • L10NStatusReport

      public L10NStatusReport()

  • Method Details

    • canGenerateReport

      public boolean canGenerateReport()
      Specified by:
      canGenerateReport in interface org.apache.maven.reporting.MavenReport
      Overrides:
      canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

    • constructResourceDirs

      protected Map<org.apache.maven.project.MavenProject,List<org.apache.maven.model.Resource>> constructResourceDirs()
      Collects resource definitions from all projects in reactor.

    • executeReport

      protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
      Specified by:
      executeReport in class org.apache.maven.reporting.AbstractMavenReport
      Throws:
      org.apache.maven.reporting.MavenReportException
      See Also:
      • AbstractMavenReport.executeReport(java.util.Locale)

    • getDescription

      public String getDescription(Locale locale)
      See Also:
      • MavenReport.getDescription(java.util.Locale)

    • getName

      public String getName(Locale locale)
      See Also:
      • MavenReport.getName(java.util.Locale)

    • getOutputName

      public String getOutputName()
      See Also:
      • MavenReport.getOutputName()