001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    package org.sonar.api.batch.sensor.highlighting;
021    
022    import com.google.common.annotations.Beta;
023    
024    /**
025     * Experimental, do not use.
026     * <p/>
027     * This builder is used to define syntax highlighting (aka code coloration) on files.
028     * @since 4.5
029     */
030    @Beta
031    public interface HighlightingBuilder {
032    
033      /**
034       * Call this method to indicate the type of text in a range.
035       * @param startOffset Starting position in file for this type of text. Beginning of a file starts with offset '0'.
036       * @param endOffset End position in file for this type of text.
037       * @param typeOfText see {@link TypeOfText} values.
038       */
039      HighlightingBuilder highlight(int startOffset, int endOffset, TypeOfText typeOfText);
040    
041      /**
042       * Call this method only once when your are done with defining highlighting of the file.
043       * @throws IllegalStateException if you have defined overlapping highlighting
044       */
045      void done();
046    }