Coverage Report - com.puppycrawl.tools.checkstyle.api.TextBlock
 
Classes in this File Line Coverage Branch Coverage Complexity
TextBlock
N/A
N/A
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 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  
      * The text content of the text block.
 31  
      * Each line is represented by one array entry.
 32  
      * The linebreak characters are not part of the text content.
 33  
      *
 34  
      * @return the text content of the text block.
 35  
      */
 36  
     String[] getText();
 37  
 
 38  
     /**
 39  
      * The line in the input file where the text block starts.
 40  
      * Counting starts from 1.
 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  
      * @return last line of the text block
 49  
      */
 50  
     int getEndLineNo();
 51  
 
 52  
     /**
 53  
      * The column in the input file where the text block starts.
 54  
      * Counting starts from 0.
 55  
      * @return first line of the text block
 56  
      */
 57  
     int getStartColNo();
 58  
 
 59  
     /**
 60  
      * The column in the input file where the text block ends.
 61  
      * Counting starts from 0.
 62  
      * @return last line of the text block
 63  
      */
 64  
     int getEndColNo();
 65  
 
 66  
     /**
 67  
      * Checks if this comment intersects with a specified
 68  
      * part of the file.
 69  
      *
 70  
      * @param startLineNo the starting line number in the file
 71  
      * @param startColNo the starting column number in the file
 72  
      * @param endLineNo the ending line number in the file
 73  
      * @param endColNo the ending column number in the file
 74  
      * @return true if the positions intersects with this comment.
 75  
      */
 76  
     boolean intersects(int startLineNo, int startColNo,
 77  
                        int endLineNo, int endColNo);
 78  
 }