Source code: javax/ide/model/java/source/tree/DocElementT.java
1 /*
2 * @(#)DocElementT.java
3 */
4
5 package javax.ide.model.java.source.tree;
6
7 import java.util.Collection;
8
9 /**
10 * Common supertype for all elements that are a part of a doc
11 * comment. Not named DocT in order to avoid confusion with
12 * com.sun.javadoc.Doc which is not the base supertype of all doc
13 * elements. <p/>
14 *
15 * "Comment text" refers to text with leading asterisks stripped. <br>
16 * "Processed text" refers to text with tags stripped. <p/>
17 *
18 * @author Louis Tribble, Andy Yu
19 */
20 public interface DocElementT
21 extends Tree, HasNameT
22 {
23 // ----------------------------------------------------------------------
24
25 /**
26 * Gets the declaration this doc element is associated with, null if
27 * none. For example, if this doc element is associated with a
28 * method declaration, this will return that method declaration.
29 *
30 * @return The associated declaration element, null if none.
31 */
32 public Tree getOwningDeclaration();
33
34 /**
35 * Gets the processed comment text for this doc element, commonly
36 * called the "description".
37 *
38 * @return The processed text for this comment.
39 */
40 public String getCommentText();
41
42 /**
43 * Gets the unprocessed comment text for this doc element.
44 *
45 * @return The unprocessed text for this comment.
46 */
47 public String getRawCommentText();
48
49 /**
50 * Gets the collection of tags contained in this doc element. A
51 * DocElementT that is not a DocCommentT may only return inline tags
52 * as part of this call.
53 *
54 * @return The collection of contained tags. <p>
55 *
56 * Collection of DocTagTs.
57 */
58 public Collection getTags();
59
60 /**
61 * Gets the collection of matching tags contained in this doc element.
62 *
63 * @param name The tag name to match. Example: {@literal @see}.
64 *
65 * @return The collection of matching tags. <p>
66 *
67 * Collection of DocTagTs.
68 */
69 public Collection getTags(String name);
70
71 }