001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.api; 020 021/** 022 * A block of text from an inputfile that does not necessarily 023 * have any grammatical structure. 024 * 025 * @author lkuehne 026 */ 027public interface TextBlock 028{ 029 /** 030 * The text content of the text block. 031 * Each line is represented by one array entry. 032 * The linebreak characters are not part of the text content. 033 * 034 * @return the text content of the text block. 035 */ 036 String[] getText(); 037 038 /** 039 * The line in the inputfile where the text block starts. 040 * Counting starts from 1. 041 * @return first line of the text block 042 */ 043 int getStartLineNo(); 044 045 /** 046 * The last line of the text block in the inputfile. 047 * Counting starts from 1. 048 * @return last line of the text block 049 */ 050 int getEndLineNo(); 051 052 /** 053 * The column in the inputfile where the text block starts. 054 * Counting starts from 0. 055 * @return first line of the text block 056 */ 057 int getStartColNo(); 058 059 /** 060 * The column in the inputfile where the text block ends. 061 * Counting starts from 0. 062 * @return last line of the text block 063 */ 064 int getEndColNo(); 065 066 /** 067 * Checks if this comment intersects with a specified 068 * part of the file. 069 * 070 * @param startLineNo the starting line number in the file 071 * @param startColNo the starting column number in the file 072 * @param endLineNo the ending line number in the file 073 * @param endColNo the ending column number in the file 074 * @return true if the positions intersects with this comment. 075 */ 076 boolean intersects(int startLineNo, int startColNo, 077 int endLineNo, int endColNo); 078}