org.sonar.wsclient.services.Violation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ws-client Show documentation
Java Client Library for SonarQube Web Services
There is a newer version: 5.1
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2013 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.wsclient.services;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;

import java.util.Date;

/**
 * @deprecated in 3.6. Replaced by issues.
 */
@Deprecated
public class Violation extends Model {

  private String message = null;
  private String severity = null;
  private Integer line = null;
  private String ruleKey = null;
  private String ruleName = null;
  private String resourceKey = null;
  private String resourceName = null;
  private String resourceQualifier = null;
  private Date createdAt = null;
  private boolean switchedOff;

  @CheckForNull
  public String getMessage() {
    return message;
  }

  public void setMessage(@Nullable String message) {
    this.message = message;
  }

  /**
   * @since 2.5
   */
  @CheckForNull
  public String getSeverity() {
    return severity;
  }

  /**
   * @since 2.5
   */
  public void setSeverity(@Nullable String severity) {
    this.severity = severity;
  }

  /**
   * @deprecated since 2.5 use {@link #getSeverity()} instead. See http://jira.codehaus.org/browse/SONAR-1829
   */
  @Deprecated
  public String getPriority() {
    return severity;
  }

  /**
   * @deprecated since 2.5 use {@link #setSeverity(String)} instead. See http://jira.codehaus.org/browse/SONAR-1829
   */
  @Deprecated
  public void setPriority(String priority) {
    this.severity = priority;
  }

  /**
   * @return line number (numeration starts from 1), or null if violation doesn't belong to concrete line
   * @see #hasLine()
   */
  @CheckForNull
  public Integer getLine() {
    return line;
  }

  public void setLine(@Nullable Integer line) {
    if (line != null && line < 1) {
      /*
       * This shouldn't happen, however line would be normalized to null if web service returns incorrect value (less than 1) in compliance
       * with a contract for getLine method. Normalization added in 2.8 - see http://jira.codehaus.org/browse/SONAR-2386
       */
      this.line = null;
    } else {
      this.line = line;
    }
  }

  /**
   * @return true if violation belongs to concrete line
   * @since 2.8
   */
  public boolean hasLine() {
    return line != null;
  }

  @Nullable
  public String getResourceKey() {
    return resourceKey;
  }

  public void setResourceKey(@Nullable String resourceKey) {
    this.resourceKey = resourceKey;
  }

  @CheckForNull
  public String getRuleKey() {
    return ruleKey;
  }

  public Violation setRuleKey(@Nullable String s) {
    this.ruleKey = s;
    return this;
  }

  @CheckForNull
  public String getRuleName() {
    return ruleName;
  }

  public Violation setRuleName(@Nullable String ruleName) {
    this.ruleName = ruleName;
    return this;
  }

  @CheckForNull
  public String getResourceName() {
    return resourceName;
  }

  public Violation setResourceName(@Nullable String resourceName) {
    this.resourceName = resourceName;
    return this;
  }

  @CheckForNull
  public String getResourceQualifier() {
    return resourceQualifier;
  }

  public Violation setResourceQualifier(@Nullable String resourceQualifier) {
    this.resourceQualifier = resourceQualifier;
    return this;
  }

  /**
   * @since 2.5
   */
  @CheckForNull
  public Date getCreatedAt() {
    return createdAt;
  }

  /**
   * @since 2.5
   */
  public Violation setCreatedAt(@Nullable Date createdAt) {
    this.createdAt = createdAt;
    return this;
  }

  /**
   * @since 2.5
   */
  public boolean isCreatedAfter(Date date) {
    return createdAt != null && date != null && createdAt.after(date);
  }

  /**
   * @since 2.8
   */
  public Violation setSwitchedOff(@Nullable Boolean b) {
    this.switchedOff = (b != null && b);
    return this;
  }

  /**
   * @since 2.8
   */
  @Nullable
  public boolean isSwitchedOff() {
    return switchedOff;
  }

}