com.github.sbaudoin.sonar.plugins.yaml.highlighting.HighlightingData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-yaml-plugin Show documentation
YAML 1.1 plugin for SonarQube
There is a newer version: 1.9.1
/**
 * Copyright (c) 2018-2021, Sylvain Baudoin
 *
 * Licensed 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.
 */
package com.github.sbaudoin.sonar.plugins.yaml.highlighting;

import org.sonar.api.batch.sensor.highlighting.NewHighlighting;
import org.sonar.api.batch.sensor.highlighting.TypeOfText;

/**
 * Class that stores the parameters a portion of YAML code to be highlighted and that is responsible for
 * highlighting code in Sonar
 */
public class HighlightingData {
    private final TypeOfText typeOfText;

    private int startLine;
    private int startColumnOffset;
    private int endLine;
    private int endColumnOffset;

    /**
     * Constructor
     *
     * @param startLine the line number where the highlighted portion of code starts
     * @param startColumnIndex the column number where the highlighted portion of code starts
     * @param endLine the line number where the highlighted portion of code ends
     * @param endColumnIndex the column number where the highlighted portion of code ends (this column is not part of
     *                       the highlighting)
     * @param typeOfText the type of text. Depending on this parameter, the highlighting in SonarQube will be different.
     */
    public HighlightingData(int startLine, int startColumnIndex, int endLine, int endColumnIndex, TypeOfText typeOfText) {
        this.startLine = startLine;
        this.startColumnOffset = startColumnIndex - 1;
        this.endLine = endLine;
        this.endColumnOffset = endColumnIndex - 1;
        this.typeOfText = typeOfText;
    }

    /**
     * Highlights the portion of code in SonarQube as described by this class
     *
     * @param highlighting SonarQube's highlighting for this portion of code
     */
    public void highlight(NewHighlighting highlighting) {
        highlighting.highlight(startLine, startColumnOffset, endLine, endColumnOffset, typeOfText);
    }

    /**
     * Returns the line number where the highlighted portion of code starts
     *
     * @return the line number where the highlighted portion of code starts
     */
    public int getStartLine() {
        return startLine;
    }

    /**
     * Returns the column number where the highlighted portion of code starts
     *
     * @return the column number where the highlighted portion of code starts
     */
    public int getStartColumnIndex() {
        return startColumnOffset + 1;
    }

    /**
     * Returns the line number where the highlighted portion of code ends
     *
     * @return the line number where the highlighted portion of code ends
     */
    public int getEndLine() {
        return endLine;
    }

    /**
     * Returns the column number where the highlighted portion of code ends
     *
     * @return the column number where the highlighted portion of code ends
     */
    public int getEndColumnIndex() {
        return endColumnOffset + 1;
    }

    /**
     * Returns the type of text
     *
     * @return the type of text
     */
    public TypeOfText getTypeOfText() {
        return typeOfText;
    }
}