com.sun.codemodel
Class JCommentPart

java.lang.Object  extended by java.util.AbstractCollection<E>      extended by java.util.AbstractList<E>          extended by java.util.ArrayList<Object>              extended by com.sun.codemodel.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 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.

Author:
Kohsuke Kawaguchi
See Also:
Serialized Form


Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
JCommentPart()
           
 
Method Summary
 booleanadd(Object o)
           
 JCommentPartappend(Object o)
          Appends a new value.
protected  voidformat(JFormatter 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, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, 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, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Constructor Detail

JCommentPart

public JCommentPart()
Method Detail

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>

format

protected void format(JFormatter f,                      String indent)
Writes this part into the formatter by using the specified indentation.



Copyright © 2005-2011
Oracle. All Rights Reserved.


NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14