View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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
24   * have any grammatical structure.
25   *
26   * @author lkuehne
27   */
28  public interface TextBlock {
29  
30      /**
31       * The text content of the text block.
32       * Each line is represented by one array entry.
33       * The linebreak characters are not part of the text content.
34       *
35       * @return the text content of the text block.
36       */
37      String[] getText();
38  
39      /**
40       * The line in the input file where the text block starts.
41       * Counting starts from 1.
42       * @return first line of the text block
43       */
44      int getStartLineNo();
45  
46      /**
47       * The last line of the text block in the input file.
48       * Counting starts from 1.
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       * @return first line of the text block
57       */
58      int getStartColNo();
59  
60      /**
61       * The column in the input file where the text block ends.
62       * Counting starts from 0.
63       * @return last line of the text block
64       */
65      int getEndColNo();
66  
67      /**
68       * Checks if this comment intersects with a specified
69       * part of the file.
70       *
71       * @param startLineNo the starting line number in the file
72       * @param startColNo the starting column number in the file
73       * @param endLineNo the ending line number in the file
74       * @param endColNo the ending column number in the file
75       * @return true if the positions intersects with this comment.
76       */
77      boolean intersects(int startLineNo, int startColNo,
78                         int endLineNo, int endColNo);
79  
80  }