org.apache.maven.plugins.checkstyle.Violation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-checkstyle-plugin Show documentation
Generates a report on violations of code style and optionally fails the build if violations are detected.
There is a newer version: 3.6.0
Show newest version
package org.apache.maven.plugins.checkstyle;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Objects;
import java.util.StringJoiner;

/**
 * Holds data about a single violation and represents the violation itself.
 */
class Violation
{

  /**
   * Indicates that a column is not set.
   */
  protected static final String NO_COLUMN = "-1";

  /** The full qualified class name of the checkstyle rule */
  private final String source;

  /** The absolute path of the file containing the violation */
  private final String file;

  private final String line;

  private String column = NO_COLUMN;

  private final String severity;

  private final String message;

  private final String ruleName;

  private final String category;

  // Leaving out column, because there is no CHECKSTYLE:OFF support.

  /**
   * Creates a violation instance without a column set.
   *
   * @param source
   *     the fully qualified class name of the checkstyle rule
   * @param file
   *     the absolute file path in which the violation occurred
   * @param line
   *     the line in the file on which the violation occurred
   * @param severity
   *     the severity of the violation
   * @param message
   *     the message from checkstyle for this violation
   * @param ruleName
   *     the rule name from which this violation was created
   * @param category
   *     the category of the checkstyle violation
   */
  Violation( String source,
                    String file,
                    String line,
                    String severity,
                    String message,
                    String ruleName,
                    String category )
  {
    this.source = Objects.requireNonNull( source );
    this.file = file;
    this.line = line;
    this.severity = Objects.requireNonNull( severity );
    this.message = Objects.requireNonNull( message );
    this.ruleName = Objects.requireNonNull( ruleName );
    this.category = Objects.requireNonNull( category );
  }

  /**
   * Returns the fully qualified class name of the checker rule.
   *
   * @return the fully qualified class name of the checker rule
   */
  protected String getSource( )
  {
    return source;
  }

  /**
   * Returns the absolute file path to the checked file.
   *
   * @return the absolute file path to the checked file
   */
  protected String getFile( )
  {
    return file;
  }

  /**
   * Returns the line in the checked file on which the violation occurred.
   *
   * @return the line in the checked file on which the violation occurred
   */
  protected String getLine( )
  {
    return line;
  }

  /**
   * Returns the column in which the violation occurred, if available.
   *
   * @return the column in which the violation occurred, if available. Otherwise returns {@link #NO_COLUMN}.
   */
  protected String getColumn( )
  {
    return column;
  }

  /**
   * Sets the column value for this violation to the given string value.
   * @param column the column value to set. May be {@code null}, which will set it to the {@link #NO_COLUMN} value.
   */
  protected void setColumn( /* Nullable */ String column )
  {
    if ( column == null || column.length() < 1 )
    {
      this.column = NO_COLUMN;
    }
    else
    {
      this.column = column;
    }
  }

  /**
   * Returns the severity of the current violation.
   *
   * @return the severity of the current violation
   */
  protected String getSeverity( )
  {
    return severity;
  }

  /**
   * Returns the message produced by checkstyle for the current violation.
   *
   * @return the message produced by checkstyle for the current violation
   */
  protected String getMessage( )
  {
    return message;
  }

  /**
   * Returns the name of the rule which led to the current violation.
   *
   * @return the name of the rule which led to the current violation
   */
  protected String getRuleName( )
  {
    return ruleName;
  }

  /**
   * Returns the category of the current violation.
   *
   * @return the category of the current violation
   */
  protected String getCategory( )
  {
    return category;
  }

  @Override
  public boolean equals( Object other )
  {
    if ( this == other )
    {
      return true;
    }
    if ( !( other instanceof Violation ) )
    {
      return false;
    }
    Violation violation = ( Violation ) other;
    return Objects.equals( line, violation.line )
        && Objects.equals( column, violation.column )
        && source.equals( violation.source )
        && Objects.equals( file, violation.file )
        && severity.equals( violation.severity )
        && message.equals( violation.message )
        && ruleName.equals( violation.ruleName )
        && category.equals( violation.category );
  }

  @Override
  public int hashCode()
  {
    return Objects.hash( source, file, line, column, severity, message, ruleName, category );
  }

  @Override
  public String toString()
  {
    return new StringJoiner( ", ", Violation.class.getSimpleName() + "[", "]" )
        .add( "source='" + source + "'" )
        .add( "file='" + file + "'" )
        .add( "line=" + line )
        .add( "column=" + column )
        .add( "severity='" + severity + "'" )
        .add( "message='" + message + "'" )
        .add( "ruleName='" + ruleName + "'" )
        .add( "category='" + category + "'" )
        .toString();
  }
}