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.cpd; 021 022import com.google.common.annotations.Beta; 023import org.sonar.api.batch.fs.InputFile; 024import org.sonar.api.batch.fs.TextRange; 025 026/** 027 * This builder is used to define tokens used by CPD algorithm on files. 028 * @since 5.5 029 */ 030@Beta 031public interface NewCpdTokens { 032 033 /** 034 * The tokenized file. 035 */ 036 NewCpdTokens onFile(InputFile inputFile); 037 038 /** 039 * Call this method to register a token in a range. Tokens should be registered in order. 040 * @param range Token position. Use {@link InputFile#newRange(int, int, int, int)} to get a valid range. 041 * @param image Text content of the token. Can be replaced by a constant placeholder for some tokens (like litterals). 042 */ 043 NewCpdTokens addToken(TextRange range, String image); 044 045 /** 046 * Call this method only once when your are done with defining tokens of the file. 047 */ 048 void save(); 049}