de.ikor.sip.foundation.mvnplugin.model.AnalyzeResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sip-maven-plugin Show documentation

The newest version!

package de.ikor.sip.foundation.mvnplugin.model;

import java.util.List;
import lombok.AllArgsConstructor;

/** Final result of analyzing the code base for banned imports. */
@AllArgsConstructor
public final class AnalyzeResult {

  private final List srcMatches;
  private final List testMatches;

  /**
   * @return discovered {@link BannedImportGroup} in the source code files
   */
  public List srcBanMatches() {
    return srcMatches;
  }

  /**
   * @return discovered {@link BannedImportGroup} in the test code files
   */
  public List testBanMatches() {
    return testMatches;
  }

  /**
   * Returns whether at least one banned import has been found within the analyzed compile OR test
   * source files.
   *
   * @return Whether a banned import has been found.
   */
  public boolean bannedImportsFound() {
    return !srcMatches.isEmpty() || !testMatches.isEmpty();
  }

  /**
   * Returns whether at least one banned import has been found within the analyzed compile source
   * code.
   *
   * @return Whether a banned import has been found.
   */
  public boolean bannedImportsInCompileCode() {
    return !srcMatches.isEmpty();
  }

  /**
   * Returns whether at least one banned import has been found within the analyzed test source code.
   *
   * @return Whether a banned import has been found.
   */
  public boolean bannedImportsInTestCode() {
    return !testMatches.isEmpty();
  }
}