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.symbol;
021    
022    import com.google.common.annotations.Beta;
023    
024    /**
025     * Experimental, do not use.
026     * <p/>
027     * Use this builder to create symbol references. For now only references
028     * in the same file are supported.
029     * @since 4.5
030     */
031    @Beta
032    public interface SymbolTableBuilder {
033    
034      /**
035       * Create a new symbol.
036       * @param fromOffset Starting offset in a file for the symbol declaration. File starts at offset '0'.
037       * @param toOffset Ending offset of symbol declaration.
038       * @return a new Symbol that can be used later in {@link #newReference(Symbol, int)}
039       */
040      Symbol newSymbol(int fromOffset, int toOffset);
041    
042      /**
043       * Records that a {@link Symbol} is referenced at another location in the same file.
044       * @param symbol Symbol previously created with {@link #newSymbol(int, int)}
045       * @param fromOffset Starting offset of the place symbol is referenced. No need for end offset here since we assume it is same length.
046       */
047      void newReference(Symbol symbol, int fromOffset);
048    
049      /**
050       * Call this method only once when your are done with defining symbols of the file.
051       */
052      void done();
053    }