blob: 592947e07c697506102d3bb099b100da6a4a117c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2016 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser.ast.nodeTypes;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.ast.comments.JavadocComment;
import com.github.javaparser.javadoc.Javadoc;
import java.util.Optional;
/**
* A node that can be documented with a Javadoc comment.
*/
public interface NodeWithJavadoc<N extends Node> {
Optional<Comment> getComment();
Node setComment(Comment comment);
/**
* Gets the JavadocComment for this node. You can set the JavadocComment by calling setJavadocComment passing a
* JavadocComment.
*
* @return The JavadocComment for this node wrapped in an optional as it may be absent.
*/
default Optional<JavadocComment> getJavadocComment() {
return getComment()
.filter(comment -> comment instanceof JavadocComment)
.map(comment -> (JavadocComment) comment);
}
/**
* Gets the Javadoc for this node. You can set the Javadoc by calling setJavadocComment passing a Javadoc.
*
* @return The Javadoc for this node wrapped in an optional as it may be absent.
*/
default Optional<Javadoc> getJavadoc() {
return getJavadocComment().map(JavadocComment::parse);
}
/**
* Use this to store additional information to this node.
*
* @param comment to be set
*/
@SuppressWarnings("unchecked")
default N setJavadocComment(String comment) {
return setJavadocComment(new JavadocComment(" " + comment));
}
default N setJavadocComment(JavadocComment comment) {
setComment(comment);
return (N) this;
}
default N setJavadocComment(String indentation, Javadoc javadoc) {
return setJavadocComment(javadoc.toComment(indentation));
}
default N setJavadocComment(Javadoc javadoc) {
return setJavadocComment(javadoc.toComment());
}
default boolean removeJavaDocComment() {
return hasJavaDocComment() && getComment().get().remove();
}
default boolean hasJavaDocComment() {
return getComment().isPresent() && getComment().get() instanceof JavadocComment;
}
}
|
