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