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 */
020package org.sonar.api.source;
021
022import org.sonar.api.component.Perspective;
023import org.sonar.api.component.ResourcePerspectives;
024
025import java.util.List;
026
027/**
028 * Use this perspective to save symbol references on files.
029 * See {@link ResourcePerspectives}.
030 * @since 3.6
031 */
032public interface Symbolizable extends Perspective {
033
034  interface SymbolTableBuilder {
035
036    Symbol newSymbol(int fromOffset, int toOffset);
037
038    void newReference(Symbol symbol, int fromOffset);
039
040    SymbolTable build();
041  }
042
043  interface SymbolTable {
044
045    List<Symbol> symbols();
046
047    List<Integer> references(Symbol symbol);
048  }
049
050  SymbolTableBuilder newSymbolTableBuilder();
051
052  void setSymbolTable(SymbolTable symbolTable);
053}