equal
deleted
inserted
replaced
1 /* |
1 /* |
2 * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. |
2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 * |
4 * |
5 * This code is free software; you can redistribute it and/or modify it |
5 * This code is free software; you can redistribute it and/or modify it |
6 * under the terms of the GNU General Public License version 2 only, as |
6 * under the terms of the GNU General Public License version 2 only, as |
7 * published by the Free Software Foundation. Oracle designates this |
7 * published by the Free Software Foundation. Oracle designates this |
41 public interface Doc extends Comparable<Object> { |
41 public interface Doc extends Comparable<Object> { |
42 |
42 |
43 /** |
43 /** |
44 * Return the text of the comment for this doc item. |
44 * Return the text of the comment for this doc item. |
45 * Tags have been removed. |
45 * Tags have been removed. |
|
46 * |
|
47 * @return the text of the comment for this doc item. |
46 */ |
48 */ |
47 String commentText(); |
49 String commentText(); |
48 |
50 |
49 /** |
51 /** |
50 * Return all tags in this Doc item. |
52 * Return all tags in this Doc item. |
117 |
119 |
118 /** |
120 /** |
119 * Return the full unprocessed text of the comment. Tags |
121 * Return the full unprocessed text of the comment. Tags |
120 * are included as text. Used mainly for store and retrieve |
122 * are included as text. Used mainly for store and retrieve |
121 * operations like internalization. |
123 * operations like internalization. |
|
124 * |
|
125 * @return the full unprocessed text of the comment. |
122 */ |
126 */ |
123 String getRawCommentText(); |
127 String getRawCommentText(); |
124 |
128 |
125 /** |
129 /** |
126 * Set the full unprocessed text of the comment. Tags |
130 * Set the full unprocessed text of the comment. Tags |
127 * are included as text. Used mainly for store and retrieve |
131 * are included as text. Used mainly for store and retrieve |
128 * operations like internalization. |
132 * operations like internalization. |
|
133 * |
|
134 * @param rawDocumentation A String containing the full unprocessed text of the comment. |
129 */ |
135 */ |
130 void setRawCommentText(String rawDocumentation); |
136 void setRawCommentText(String rawDocumentation); |
131 |
137 |
132 /** |
138 /** |
133 * Returns the non-qualified name of this Doc item. |
139 * Returns the non-qualified name of this Doc item. |
141 * negative integer, zero, or a positive integer as this doc object is less |
147 * negative integer, zero, or a positive integer as this doc object is less |
142 * than, equal to, or greater than the given object. |
148 * than, equal to, or greater than the given object. |
143 * <p> |
149 * <p> |
144 * This method satisfies the {@link java.lang.Comparable} interface. |
150 * This method satisfies the {@link java.lang.Comparable} interface. |
145 * |
151 * |
146 * @param obj the <code>Object</code> to be compared. |
152 * @param obj the {@code Object} to be compared. |
147 * @return a negative integer, zero, or a positive integer as this Object |
153 * @return a negative integer, zero, or a positive integer as this Object |
148 * is less than, equal to, or greater than the given Object. |
154 * is less than, equal to, or greater than the given Object. |
149 * @exception ClassCastException the specified Object's type prevents it |
155 * @exception ClassCastException the specified Object's type prevents it |
150 * from being compared to this Object. |
156 * from being compared to this Object. |
151 */ |
157 */ |
248 |
254 |
249 /** |
255 /** |
250 * Return true if this Doc item is |
256 * Return true if this Doc item is |
251 * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a> |
257 * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a> |
252 * in the result set. |
258 * in the result set. |
|
259 * |
|
260 * @return true if this Doc item is |
|
261 * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a> |
|
262 * in the result set. |
253 */ |
263 */ |
254 boolean isIncluded(); |
264 boolean isIncluded(); |
255 |
265 |
256 /** |
266 /** |
257 * Return the source position of the first line of the |
267 * Return the source position of the first line of the |
258 * corresponding declaration, or null if |
268 * corresponding declaration, or null if |
259 * no position is available. A default constructor returns |
269 * no position is available. A default constructor returns |
260 * null because it has no location in the source file. |
270 * null because it has no location in the source file. |
261 * |
271 * |
262 * @since 1.4 |
272 * @since 1.4 |
|
273 * @return the source positino of the first line of the |
|
274 * corresponding declaration, or null if |
|
275 * no position is available. A default constructor returns |
|
276 * null because it has no location in the source file. |
263 */ |
277 */ |
264 SourcePosition position(); |
278 SourcePosition position(); |
265 } |
279 } |