Class JCommentPart

java.lang.Object

java.util.AbstractCollection<Object>

java.util.AbstractList<Object>

java.util.ArrayList<Object>

com.sun.codemodel.JCommentPart

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, SequencedCollection<Object>

Direct Known Subclasses:

JDocComment

public class JCommentPart
extends ArrayList<Object>

A part is a part of a javadoc comment, and it is a list of values.

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.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
JCommentPart()

Method Summary

Modifier and Type	Method	Description
boolean	add(Object o)
JCommentPart	append(Object o)	Appends a new value.
private String	escape(String s)	Escapes the appearance of the comment terminator.
private void	flattenAppend(Object value)
protected void	format(JFormatter f, String indent)	Writes this part into the formatter by using the specified indentation.

Methods inherited from class ArrayList

add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class AbstractCollection

containsAll, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, stream, toArray

Methods inherited from interface List

containsAll, reversed

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

JCommentPart

public JCommentPart()

Method Details

append

public JCommentPart append(Object o)

Appends a new value. If the value is JType it will be printed as a @link tag. Otherwise it will be converted to String via Object.toString().

add

public boolean add(Object o)

Specified by:

add in interface Collection<Object>

Specified by:

add in interface List<Object>

Overrides:

add in class ArrayList<Object>

flattenAppend

private void flattenAppend(Object value)

format

protected void format(JFormatter f,
 String indent)

Writes this part into the formatter by using the specified indentation.

escape

private String escape(String s)

Escapes the appearance of the comment terminator.