001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 the original author or authors.
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///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.api;
021
022/**
023 * A block of text from an input file that does not necessarily have any grammatical structure.
024 *
025 */
026public interface TextBlock {
027
028    /**
029     * The text content of the text block.
030     * Each line is represented by one array entry.
031     * The linebreak characters are not part of the text content.
032     *
033     * @return the text content of the text block.
034     */
035    String[] getText();
036
037    /**
038     * The line in the input file where the text block starts.
039     * Counting starts from 1.
040     *
041     * @return first line of the text block
042     */
043    int getStartLineNo();
044
045    /**
046     * The last line of the text block in the input file.
047     * Counting starts from 1.
048     *
049     * @return last line of the text block
050     */
051    int getEndLineNo();
052
053    /**
054     * The column in the input file where the text block starts.
055     * Counting starts from 0.
056     *
057     * @return first line of the text block
058     */
059    int getStartColNo();
060
061    /**
062     * The column in the input file where the text block ends.
063     * Counting starts from 0.
064     *
065     * @return last line of the text block
066     */
067    int getEndColNo();
068
069    /**
070     * Checks if this comment intersects with a specified part of the file.
071     *
072     * @param startLineNo the starting line number in the file
073     * @param startColNo the starting column number in the file
074     * @param endLineNo the ending line number in the file
075     * @param endColNo the ending column number in the file
076     * @return true if the positions intersects with this comment.
077     */
078    boolean intersects(int startLineNo, int startColNo,
079                       int endLineNo, int endColNo);
080
081}