1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.api;
21
22 /**
23 * A block of text from an input file that does not necessarily have any grammatical structure.
24 *
25 */
26 public interface TextBlock {
27
28 /**
29 * The text content of the text block.
30 * Each line is represented by one array entry.
31 * The linebreak characters are not part of the text content.
32 *
33 * @return the text content of the text block.
34 */
35 String[] getText();
36
37 /**
38 * The line in the input file where the text block starts.
39 * Counting starts from 1.
40 *
41 * @return first line of the text block
42 */
43 int getStartLineNo();
44
45 /**
46 * The last line of the text block in the input file.
47 * Counting starts from 1.
48 *
49 * @return last line of the text block
50 */
51 int getEndLineNo();
52
53 /**
54 * The column in the input file where the text block starts.
55 * Counting starts from 0.
56 *
57 * @return first line of the text block
58 */
59 int getStartColNo();
60
61 /**
62 * The column in the input file where the text block ends.
63 * Counting starts from 0.
64 *
65 * @return last line of the text block
66 */
67 int getEndColNo();
68
69 /**
70 * Checks if this comment intersects with a specified part of the file.
71 *
72 * @param startLineNo the starting line number in the file
73 * @param startColNo the starting column number in the file
74 * @param endLineNo the ending line number in the file
75 * @param endColNo the ending column number in the file
76 * @return true if the positions intersects with this comment.
77 */
78 boolean intersects(int startLineNo, int startColNo,
79 int endLineNo, int endColNo);
80
81 }