org.mule.devkit.model.code

Class CommentPart

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

org.mule.devkit.model.code.CommentPart

All Implemented Interfaces:

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

Direct Known Subclasses:

GeneratedJavaDocComment

public class CommentPart
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 Type (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
CommentPart()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Object o)
CommentPart	append(Object o) Appends a new value.
protected void	format(Formatter f, String indent) 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, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, 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

Constructor Detail

CommentPart

public CommentPart()

Method Detail

append

public CommentPart append(Object o)

Appends a new value.

If the value is Type 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>

format

protected void format(Formatter f,
          String indent)

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