Package org.apache.maven.plugins.javadoc

Class StaleHelper

  • public class StaleHelper
extends java.lang.Object
    Helper class to compute and write data used to detect a stale javadoc.

    • Constructor Summary

      Constructors 
      Constructor Description
      StaleHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<java.lang.String> getStaleData​(org.codehaus.plexus.util.cli.Commandline cmd)
      Compute the data used to detect a stale javadoc
      static void writeStaleData​(org.codehaus.plexus.util.cli.Commandline cmd, java.nio.file.Path path)
      Write the data used to detect a stale javadoc

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StaleHelper

        public StaleHelper()

    • Method Detail

      • getStaleData

        public static java.util.List<java.lang.String> getStaleData​(org.codehaus.plexus.util.cli.Commandline cmd)
                                                     throws org.apache.maven.reporting.MavenReportException
        Compute the data used to detect a stale javadoc
        Parameters:
        cmd - the command line
        Returns:
        the stale data
        Throws:
        org.apache.maven.reporting.MavenReportException - if an error occurs

      • writeStaleData

        public static void writeStaleData​(org.codehaus.plexus.util.cli.Commandline cmd,
                                  java.nio.file.Path path)
                           throws org.apache.maven.reporting.MavenReportException
        Write the data used to detect a stale javadoc
        Parameters:
        cmd - the command line
        path - the stale data path
        Throws:
        org.apache.maven.reporting.MavenReportException - if an error occurs