JDocComment
public class JCommentPart
extends java.util.ArrayList<java.lang.Object>
A part can contain a free-form text. This text is modeled as a collection of 'values'
in this class. A value can be a JType
(which will be prinited with a @link tag),
anything that can be turned into a String
via the Object.toString()
method,
or a Collection
/array of those objects.
Values can be added through the various append methods one by one or in a bulk.
Constructor | Description |
---|---|
JCommentPart() |
Modifier and Type | Method | Description |
---|---|---|
boolean |
add(java.lang.Object o) |
|
JCommentPart |
append(java.lang.Object o) |
Appends a new value.
|
protected void |
format(JFormatter f,
java.lang.String indent) |
Writes this part into the formatter by using the specified indentation.
|
add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
public JCommentPart append(java.lang.Object o)
JType
it will be printed as a @link tag.
Otherwise it will be converted to String via Object.toString()
.public boolean add(java.lang.Object o)
add
in class java.util.ArrayList<java.lang.Object>
protected void format(JFormatter f, java.lang.String indent)
Copyright © 2018 Oracle Corporation. All rights reserved.