org.sonar.javascript.checks.verifier.TestIssue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javascript-checks-testkit Show documentation
The newest version!
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.javascript.checks.verifier;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.annotation.Nullable;

class TestIssue {

  public static class Location {

    private String message;
    private int line;
    private Integer startColumn = null;
    private Integer endColumn = null;
    private Integer endLine = null;

    private Location(@Nullable String message, int line) {
      this.message = message;
      this.line = line;
    }

    public String message() {
      return message;
    }

    public int line() {
      return line;
    }

    public Integer startColumn() {
      return startColumn;
    }

    public Integer endColumn() {
      return endColumn;
    }
  }

  private String id = null;

  private Integer effortToFix = null;

  private Location primaryLocation;
  private List secondaryLocations = new ArrayList<>();


  private TestIssue(@Nullable String message, int line) {
    primaryLocation = new Location(message, line);
  }

  public static TestIssue create(@Nullable String message, int lineNumber) {
    return new TestIssue(message, lineNumber);
  }

  public void id(String value) {
    this.id = value;
  }

  public TestIssue message(String message) {
    this.primaryLocation.message = message;
    return this;
  }

  public TestIssue columns(int startColumn, int endColumn) {
    startColumn(startColumn);
    endColumn(endColumn);
    return this;
  }

  public TestIssue startColumn(int startColumn) {
    this.primaryLocation.startColumn = startColumn;
    return this;
  }

  public TestIssue endColumn(int endColumn) {
    this.primaryLocation.endColumn = endColumn;
    return this;
  }

  public TestIssue effortToFix(int effortToFix) {
    this.effortToFix = effortToFix;
    return this;
  }

  public TestIssue endLine(int endLine) {
    this.primaryLocation.endLine = endLine;
    return this;
  }

  public TestIssue secondary(Integer... lines) {
    return this.secondary(Arrays.asList(lines));
  }

  public TestIssue secondary(List secondaryLines) {
    for (int line : secondaryLines) {
      secondaryLocations.add(new Location(null, line));
    }
    return this;
  }

  public TestIssue secondary(@Nullable String message, int line, int startColumn, int endColumn) {
    Location location = new Location(message, line);
    location.startColumn = startColumn;
    location.endColumn = endColumn;
    secondaryLocations.add(location);
    return this;
  }

  public int line() {
    return primaryLocation.line;
  }

  public Integer startColumn() {
    return primaryLocation.startColumn;
  }

  public Integer endLine() {
    return primaryLocation.endLine;
  }

  public Integer endColumn() {
    return primaryLocation.endColumn;
  }

  public String message() {
    return primaryLocation.message;
  }

  public String id() {
    return id;
  }

  public Integer effortToFix() {
    return effortToFix;
  }

  public List secondaryLocations() {
    return secondaryLocations;
  }

}