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 * @since 5.6 028 */ 029public interface NewSymbol { 030 031 /** 032 * Register a new symbol reference. 033 * @param startOffset Starting position in file for the declaration of this symbol. Beginning of a file starts with offset '0'. 034 * @param endOffset End position in file for this symbol declaration. 035 */ 036 NewSymbol newReference(int startOffset, int endOffset); 037 038 /** 039 * Register a new symbol. 040 * @param range Range of text for the symbol declaration. See for example {@link InputFile#newRange(int, int, int, int)}. 041 */ 042 NewSymbol newReference(TextRange range); 043 044 /** 045 * Shortcut to avoid calling {@link InputFile#newRange(int, int, int, int)} 046 */ 047 NewSymbol newReference(int startLine, int startLineOffset, int endLine, int endLineOffset); 048}