Class ParamsTask

src/main/java/com/rtg/launcher/ParamsTask.java:45–137

Common code for those modules/tasks that can be configured via a ModuleParams. @param type of underlying implementation. @param type of statistics object.

 * @param <S> type of statistics object.
 */
public abstract class ParamsTask<P extends ModuleParams, S extends Statistics> implements IORunnable {

  protected P mParams;  //see bug 1447 for why this is not final
  protected final OutputStream mReportStream;
  protected final UsageMetric mUsageMetric;

  /** Declared here to keep the testing boffins happy */
  protected S mStatistics;

  /**
   * @param params parameters for the build and search.
   * @param reportStream stream to write statistics to.
   * @param stats statistics object to populate.
   * @param usageMetric keeps track of usage for the current module.
   */
  protected ParamsTask(final P params, final OutputStream reportStream, S stats, final UsageMetric usageMetric) {
    assert params != null;
    mParams = params;
    mReportStream = reportStream;
    mStatistics = stats;
    mUsageMetric = usageMetric;
  }

  /**
   * @return usage counter.
   */
  public long usage() {
    return mUsageMetric.getMetric();
  }

  /**
   * Execute the current task.  Does not return until the task
   * (including possible subtasks) have completed. This implementation
   * manages creation of the output directory, calling the exec
   * method, creating a done file, and closing the params upon
   * completion.
   * @throws IOException if there is a problem.
   */
  @Override
  public void run() throws IOException {
    try {
      FileUtils.ensureOutputDirectory(mParams.directory());
      exec();
      generateSummary();
      generateReport();
    } finally {
      mParams.close();
    }
  }

  /**
   * Subclasses should do all their work here
   * @throws IOException if there is a problem.
   */
  protected abstract void exec() throws IOException;

  /**
   * Default statistics output delegates to Statistics object