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 021import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl; 022 023/** 024 * 025 * DetailNode is used to construct tree during parsing Javadoc comments. 026 * Contains array of children, parent node and other useful fields. 027 * 028 * @author Baratali Izmailov 029 * @see JavadocNodeImpl 030 * @see AbstractJavdocCheck 031 */ 032public interface DetailNode 033{ 034 /** 035 * Node type. 036 * @return node type. 037 * @see JavadocTokenType 038 */ 039 int getType(); 040 041 /** 042 * Node text. 043 * @return node text 044 */ 045 String getText(); 046 047 /** 048 * Node line number. 049 * @return node line number 050 */ 051 int getLineNumber(); 052 053 /** 054 * Node column number. 055 * @return node column number. 056 */ 057 int getColumnNumber(); 058 059 /** 060 * Array of children. 061 * @return array of children 062 */ 063 DetailNode[] getChildren(); 064 065 /** 066 * Parent node. 067 * @return parent node. 068 */ 069 DetailNode getParent(); 070 071 /** 072 * Node index among parent's children. 073 * @return index 074 */ 075 int getIndex(); 076}