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 */ 020package org.sonar.api.batch.sensor.duplication; 021 022import com.google.common.annotations.Beta; 023import org.sonar.api.batch.fs.InputFile; 024 025/** 026 * <p/> 027 * This builder is used to declare duplications on files of the project. 028 * Usage: 029 * <code><pre> 030 * context.newDuplication(); 031 * .originBlock(inputFile, 2, 10) 032 * .isDuplicatedBy(inputFile, 14, 22) 033 * .isDuplicatedBy(anotherInputFile, 3, 11) 034 * .save(); 035 * </pre></code> 036 * @since 5.1 037 */ 038@Beta 039public interface NewDuplication { 040 041 /** 042 * Declare duplication origin block. Then call {@link #isDuplicatedBy(InputFile, int, int)} to reference all duplicates of this block. 043 */ 044 NewDuplication originBlock(InputFile originFile, int startLine, int endLine); 045 046 /** 047 * Declare duplicate block of the previously declared {@link #originBlock(int, int)}. Can be called several times. 048 * @param sameOrOtherFile duplicate can be in the same file or in another file. 049 */ 050 NewDuplication isDuplicatedBy(InputFile sameOrOtherFile, int startLine, int endLine); 051 052 /** 053 * Save the duplication. 054 */ 055 void save(); 056}