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.fs; 021 022/** 023 * Represents a text range in an {@link InputFile}. 024 * 025 * A range is delimited by two {@link TextPointer}. 026 * <ul> 027 * <li><code>TextRange(TextPointer(1, 0), TextPointer(1, 1))</code> represents the first character at line 1</li> 028 * <li><code>TextRange(TextPointer(1, 0), TextPointer(1, 10))</code> represents the 10 first characters at line 1</li> 029 * </ul> 030 * @see InputFile#newRange(int, int, int, int) 031 * 032 * @since 5.2 033 */ 034public interface TextRange { 035 036 /** 037 * Start position of the range 038 */ 039 TextPointer start(); 040 041 /** 042 * End position of the range 043 */ 044 TextPointer end(); 045 046 /** 047 * Test if the current range has some common area with another range. 048 * Exemple: say the two ranges are on same line. Range with offsets [1,3] overlaps range with offsets [2,4] but not 049 * range with offset [3,5] 050 */ 051 boolean overlap(TextRange another); 052 053}