forked from openjdk/jdk
/
SnippetTree.java
70 lines (65 loc) · 2.34 KB
/
SnippetTree.java
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
/*
* Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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 General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.source.doctree;
import java.util.List;
/**
* A tree node for an {@code @snippet} inline tag, as specified by
* <a href="http://openjdk.java.net/jeps/413">JEP 413</a>.
*
* <pre>
* {@snippet :
* body
* }
*
* {@snippet attributes}
*
* {@snippet attributes :
* body
* }
* </pre>
*
* @since 18
*/
public interface SnippetTree extends InlineTagTree {
/**
* Returns the list of the attributes of the {@code @snippet} tag.
*
* @return the list of the attributes
*/
List<? extends DocTree> getAttributes();
/**
* Returns the body of the {@code @snippet} tag, or {@code null} if there is no body.
*
* @apiNote
* An instance of {@code SnippetTree} with an empty body differs from an
* instance of {@code SnippetTree} with no body.
* If a tag has no body, then calling this method returns {@code null}.
* If a tag has an empty body, then this method returns a {@code TextTree}
* whose {@link TextTree#getBody()} returns an empty string.
*
* @return the body of the tag, or {@code null} if there is no body
*/
TextTree getBody();
}