1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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 * @see com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
27 * @see com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
28 */
29 public interface DetailNode {
30
31 /**
32 * Node type.
33 *
34 * @return node type.
35 * @see JavadocTokenTypes
36 */
37 int getType();
38
39 /**
40 * Node text.
41 *
42 * @return node text
43 */
44 String getText();
45
46 /**
47 * Node line number.
48 *
49 * @return node line number
50 */
51 int getLineNumber();
52
53 /**
54 * Node column number.
55 *
56 * @return node column number.
57 */
58 int getColumnNumber();
59
60 /**
61 * Array of children.
62 *
63 * @return array of children
64 */
65 DetailNode[] getChildren();
66
67 /**
68 * Parent node.
69 *
70 * @return parent node.
71 */
72 DetailNode getParent();
73
74 /**
75 * Node index among parent's children.
76 *
77 * @return index
78 */
79 int getIndex();
80
81 }