com.helger.jcodemodel

Class JCommentPart

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

com.helger.jcodemodel.JCommentPart

All Implemented Interfaces:

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

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 AbstractJType (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.

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
JCommentPart()

Method Summary

Modifier and Type	Method and Description
boolean	add(Object aValue)
JCommentPart	append(Object aValue) Appends a new value.
protected void	format(IJFormatter f, String sIndent) Writes this part into the formatter by using the specified indentation.

Methods inherited from class java.util.ArrayList

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

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

JCommentPart

public JCommentPart()

Method Detail

append

@Nonnull
public JCommentPart append(@Nullable
                                     Object aValue)

Appends a new value.

Parameters:

aValue - If the value is AbstractJType it will be printed as a @link tag. Otherwise it will be converted to String via Object.toString().

Returns:

this for chaining

add

public boolean add(@Nullable
                   Object aValue)

Specified by:

add in interface Collection<Object>

Specified by:

add in interface List<Object>

Overrides:

add in class ArrayList<Object>

format

protected void format(@Nonnull
                      IJFormatter f,
                      String sIndent)

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

Parameters:

f - Formatter to use

sIndent - Indentation to use