1/*
2 * Copyright (C) 2007-2010 Júlio Vilmar Gesser.
3 * Copyright (C) 2011, 2013-2015 The JavaParser Team.
4 *
5 * This file is part of JavaParser.
6 *
7 * JavaParser can be used either under the terms of
8 * a) the GNU Lesser General Public License as published by
9 *     the Free Software Foundation, either version 3 of the License, or
10 *     (at your option) any later version.
11 * b) the terms of the Apache License
12 *
13 * You should have received a copy of both licenses in LICENCE.LGPL and
14 * LICENCE.APACHE. Please refer to those files for details.
15 *
16 * JavaParser is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 */
21
22package com.github.javaparser.ast.nodeTypes;
23
24import com.github.javaparser.ast.Node;
25import com.github.javaparser.ast.comments.JavadocComment;
26
27/**
28 * Node which can be documented through a Javadoc comment.
29 */
30public interface NodeWithJavaDoc<T> {
31    /**
32     * Gets the JavaDoc for this node. You can set the JavaDoc by calling setComment with a JavadocComment.
33     *
34     * @return The JavaDoc for this node if it exists, null if it doesn't.
35     */
36    JavadocComment getJavaDoc();
37
38    /**
39     * Use this to store additional information to this node.
40     *
41     * @param comment to be set
42     */
43    @SuppressWarnings("unchecked")
44    public default T setJavaDocComment(String comment) {
45        ((Node) this).setComment(new JavadocComment(comment));
46        return (T) this;
47    }
48}
49