001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact 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.batch.sensor.symbol; 021 022import org.sonar.api.batch.fs.InputFile; 023import org.sonar.api.batch.fs.TextRange; 024 025/** 026 * This builder is used to define symbol references on files. 027 * 028 * Example: 029 * 030 * <pre> 031 * NewSymbolTable symbolTable = sensorContext.newSymbolTable().onFile(inputFile); 032 * symbolTable.newSymbol(1, 10, 1, 15) 033 * .newReference(10, 12, 10, 17) 034 * .newReference(11, 11, 11, 16); 035 * 036 * // Add more symbols if needed 037 * 038 * symbolTable.save(); 039 * 040 * </pre> 041 * 042 * @since 5.6 043 */ 044public interface NewSymbolTable { 045 046 /** 047 * The file the symbol table belongs to. 048 */ 049 NewSymbolTable onFile(InputFile inputFile); 050 051 /** 052 * Register a new symbol declaration. 053 * @param startOffset Starting position in file for the declaration of this symbol. Beginning of a file starts with offset '0'. 054 * @param endOffset End position in file for this symbol declaration. 055 * @deprecated since 5.6 Only supported to ease migration from old API. Please prefer {@link #newSymbol(int, int, int, int)}. 056 */ 057 @Deprecated 058 NewSymbol newSymbol(int startOffset, int endOffset); 059 060 /** 061 * Register a new symbol declaration. 062 * @param range Range of text for the symbol declaration. See for example {@link InputFile#newRange(int, int, int, int)}. 063 */ 064 NewSymbol newSymbol(TextRange range); 065 066 /** 067 * Shortcut to avoid calling {@link InputFile#newRange(int, int, int, int)} 068 */ 069 NewSymbol newSymbol(int startLine, int startLineOffset, int endLine, int endLineOffset); 070 071 /** 072 * Call this method only once when your are done with defining all symbols of the file. 073 * @throws IllegalStateException if you have defined overlapping symbols 074 */ 075 void save(); 076}