net.sourceforge.pmd.cpd.Mark Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-core Show documentation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available. Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

There is a newer version: 7.5.0-metrics

Show newest version

/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.cpd;

import java.util.Objects;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import net.sourceforge.pmd.lang.document.FileId;
import net.sourceforge.pmd.lang.document.FileLocation;
import net.sourceforge.pmd.lang.document.TextRange2d;

/**
 * A range of tokens in a source file, identified by a start and end
 * token (both included in the range). The start and end token may be
 * the same token.
 */
public final class Mark implements Comparable {

    private final @NonNull TokenEntry token;
    private @Nullable TokenEntry endToken;

    Mark(@NonNull TokenEntry token) {
        this.token = token;
    }

    @NonNull TokenEntry getToken() {
        return this.token;
    }

    @NonNull TokenEntry getEndToken() {
        return endToken == null ? token : endToken;
    }

    /**
     * Return the location of this source range in the source file.
     */
    public FileLocation getLocation() {
        TokenEntry endToken = getEndToken();
        return FileLocation.range(
            getFileId(),
            TextRange2d.range2d(token.getBeginLine(), token.getBeginColumn(),
                                endToken.getEndLine(), endToken.getEndColumn()));
    }

    FileId getFileId() {
        return token.getFileId();
    }

    public int getBeginTokenIndex() {
        return this.token.getIndex();
    }

    public int getEndTokenIndex() {
        return getEndToken().getIndex();
    }

    void setEndToken(@NonNull TokenEntry endToken) {
        assert endToken.getFileId().equals(token.getFileId())
            : "Tokens are not from the same file";
        this.endToken = endToken;
    }


    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + token.hashCode();
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Mark other = (Mark) obj;
        return Objects.equals(token, other.token)
            && Objects.equals(endToken, other.endToken);
    }

    @Override
    public int compareTo(Mark other) {
        return getToken().compareTo(other.getToken());
    }

}