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.duplication;
021    
022    
023    /**
024     * This builder is used to define token on files. Tokens are later used to compute duplication.
025     * Tokens should be declared in sequential order.
026     * Example:
027     * <code><pre>
028     * DuplicationTokenBuilder tokenBuilder = context.duplicationTokenBuilder(inputFile)
029     *  .addToken(1, "public")
030     *  .addToken(1, "class")
031     *  .addToken(1, "Foo")
032     *  .addToken(1, "{")
033     *  .addToken(2, "}")
034     *  .done();
035     * </pre></code>
036     * @since 4.5
037     */
038    public interface DuplicationTokenBuilder {
039    
040      /**
041       * Call this method to register a new token.
042       * @param line Line number of the token. Line starts at 1.
043       * @param image Text of the token.
044       */
045      DuplicationTokenBuilder addToken(int line, String image);
046    
047      /**
048       * Call this method only once when your are done with defining tokens of the file.
049       */
050      void done();
051    }