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 org.sonar.api.batch.fs.InputFile; 023import org.sonar.api.batch.fs.TextRange; 024 025/** 026 * This builder is used to define tokens used by CPD algorithm on files. 027 * 028 * Example: 029 * 030 * <pre> 031 * sensorContext.newCpdTokens().onFile(inputFile) 032 * .addToken(1, 10, 1, 15, "class") 033 * .addToken(1, 16, 1, 18, "IDENTIFIER") 034 * // Add more tokens 035 * .save; 036 * 037 * </pre> 038 * @since 5.5 039 */ 040public interface NewCpdTokens { 041 042 /** 043 * The tokenized file. 044 */ 045 NewCpdTokens onFile(InputFile inputFile); 046 047 /** 048 * Call this method to register a token in a range. Tokens should be registered in order. 049 * @param range Token position. Use {@link InputFile#newRange(int, int, int, int)} to get a valid range. 050 * @param image Text content of the token. Can be replaced by a constant placeholder for some tokens (like litterals). 051 */ 052 NewCpdTokens addToken(TextRange range, String image); 053 054 /** 055 * Shortcut to avoid calling {@link InputFile#newRange(int, int, int, int)} 056 * @since 5.6 057 */ 058 NewCpdTokens addToken(int startLine, int startLineOffset, int endLine, int endLineOffset, String image); 059 060 /** 061 * Call this method only once when your are done with defining tokens of the file. It is not supported to save CPD tokens twice for the same file. 062 */ 063 void save(); 064}