001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.source;
021
022import org.sonar.api.batch.sensor.SensorContext;
023import org.sonar.api.component.Perspective;
024import org.sonar.api.component.ResourcePerspectives;
025
026/**
027 * Use this perspective to save syntax highlighting on files.
028 * See {@link ResourcePerspectives}.
029 * @since 3.6
030 * @deprecated since 5.6 use {@link SensorContext#newHighlighting()}
031 */
032@Deprecated
033public interface Highlightable extends Perspective {
034
035  interface HighlightingBuilder {
036
037    HighlightingBuilder highlight(int startOffset, int endOffset, String typeOfText);
038
039    /**
040     * @since 5.6
041     */
042    HighlightingBuilder highlight(int startLine, int startLineOffset, int endLine, int endLineOffset, String typeOfText);
043
044    void done();
045  }
046
047  HighlightingBuilder newHighlighting();
048}