001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2016 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 022import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl; 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 com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck 031 */ 032public interface DetailNode { 033 /** 034 * Node type. 035 * @return node type. 036 * @see JavadocTokenTypes 037 */ 038 int getType(); 039 040 /** 041 * Node text. 042 * @return node text 043 */ 044 String getText(); 045 046 /** 047 * Node line number. 048 * @return node line number 049 */ 050 int getLineNumber(); 051 052 /** 053 * Node column number. 054 * @return node column number. 055 */ 056 int getColumnNumber(); 057 058 /** 059 * Array of children. 060 * @return array of children 061 */ 062 DetailNode[] getChildren(); 063 064 /** 065 * Parent node. 066 * @return parent node. 067 */ 068 DetailNode getParent(); 069 070 /** 071 * Node index among parent's children. 072 * @return index 073 */ 074 int getIndex(); 075}