gov.nist.secauto.swid.plugin.entry.AbstractFileEntryProcessor Maven / Gradle / Ivy

Go to download
/**
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.swid.plugin.entry;

import org.apache.maven.plugin.logging.Log;

import java.io.IOException;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Objects;

public abstract class AbstractFileEntryProcessor {
  private final Log log;

  /**
   * Construct a new processor.
   * 
   * @param log
   *          the Maven logger
   */
  public AbstractFileEntryProcessor(Log log) {
    super();
    Objects.requireNonNull(log);
    this.log = log;
  }

  /**
   * Retrieve the Maven logger instance.
   * 
   * @return the log
   */
  public Log getLog() {
    return log;
  }

  /**
   * Process a collection of resources, extracting matching files.
   * 
   * @param resources
   *          the resources to process
   * @return a list of FileEntry instances representing the matching files
   * @throws IOException
   *           if an error occurred while processing the files
   */
  public List process(List resources) throws IOException {
    List retval = new LinkedList<>();
    for (T record : resources) {
      retval.addAll(generateFileEntries(record));
    }
    return retval;
  }

  protected abstract Collection generateFileEntries(T record) throws IOException;
}