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   * DetailNode is used to construct tree during parsing Javadoc comments.
24   * Contains array of children, parent node and other useful fields.
25   *
26   * @author Baratali Izmailov
27   * @see com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
28   * @see com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
29   */
30  public interface DetailNode {
31  
32      /**
33       * Node type.
34       * @return node type.
35       * @see JavadocTokenTypes
36       */
37      int getType();
38  
39      /**
40       * Node text.
41       * @return node text
42       */
43      String getText();
44  
45      /**
46       * Node line number.
47       * @return node line number
48       */
49      int getLineNumber();
50  
51      /**
52       * Node column number.
53       * @return node column number.
54       */
55      int getColumnNumber();
56  
57      /**
58       * Array of children.
59       * @return array of children
60       */
61      DetailNode[] getChildren();
62  
63      /**
64       * Parent node.
65       * @return parent node.
66       */
67      DetailNode getParent();
68  
69      /**
70       * Node index among parent's children.
71       * @return index
72       */
73      int getIndex();
74  
75  }