com.sun.codemodel
Class JDocComment

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                  extended by com.sun.codemodel.JDocComment
All Implemented Interfaces:
JGenerable, Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess

public class JDocComment
extends JCommentPart
implements JGenerable

JavaDoc comment.

A javadoc comment consists of multiple parts. There's the main part (that comes the first in in the comment section), then the parameter parts (@param), the return part (@return), and the throws parts (@throws). TODO: it would be nice if we have JComment class and we can derive this class from there.

See Also:
Serialized Form


Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
JDocComment(JCodeModel owner)
           
 
Method Summary
 JCommentPartaddDeprecated()
          add an @deprecated tag to the javadoc, with the associated message.
 JCommentPartaddParam(JVar param)
          Append a text to an @param tag.
 JCommentPartaddParam(String param)
          Append a text to a @param tag to the javadoc
 JCommentPartaddReturn()
          Appends a text to @return tag.
 JCommentPartaddThrows(Class<? extends Throwable> exception)
          add an @throws tag to the javadoc
 JCommentPartaddThrows(JClass exception)
          add an @throws tag to the javadoc
 Map<String,String>addXdoclet(String name)
          add an xdoclet.
 Map<String,String>addXdoclet(String name, Map<String,String> attributes)
          add an xdoclet.
 Map<String,String>addXdoclet(String name, String attribute, String value)
          add an xdoclet.
 JDocCommentappend(Object o)
          Appends a new value.
 voidgenerate(JFormatter f)
           
 
Methods inherited from class com.sun.codemodel.JCommentPart
add, format
 
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

JDocComment

public JDocComment(JCodeModel owner)
Method Detail

append

public JDocComment append(Object o)
Description copied from class: JCommentPart
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().

Overrides:
append in class JCommentPart

addParam

public JCommentPart addParam(String param)
Append a text to a @param tag to the javadoc


addParam

public JCommentPart addParam(JVar param)
Append a text to an @param tag.


addThrows

public JCommentPart addThrows(Class<? extends Throwable> exception)
add an @throws tag to the javadoc


addThrows

public JCommentPart addThrows(JClass exception)
add an @throws tag to the javadoc


addReturn

public JCommentPart addReturn()
Appends a text to @return tag.


addDeprecated

public JCommentPart addDeprecated()
add an @deprecated tag to the javadoc, with the associated message.


addXdoclet

public Map<String,String> addXdoclet(String name)
add an xdoclet.


addXdoclet

public Map<String,String> addXdoclet(String name,                                     Map<String,String> attributes)
add an xdoclet.


addXdoclet

public Map<String,String> addXdoclet(String name,                                     String attribute,                                     String value)
add an xdoclet.


generate

public void generate(JFormatter f)
Specified by:
generate in interface JGenerable


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