Class JDocComment

java.lang.Object

java.util.AbstractCollection<Object>

java.util.AbstractList<Object>

java.util.ArrayList<Object>

com.sun.codemodel.JCommentPart

com.sun.codemodel.JDocComment

All Implemented Interfaces:

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

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

Modifier and Type	Field	Description
private JCommentPart	atDeprecated	The @deprecated tag
private final Map<String, JCommentPart>	atParams	list of @param tags
private JCommentPart	atReturn	The @return tag part.
private final Map<JClass, JCommentPart>	atThrows	list of @throws tags
private final Map<String, Map<String,String>>	atXdoclets	list of xdoclets
private static final String	INDENT
private final JCodeModel	owner
private static final long	serialVersionUID

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
JDocComment(JCodeModel owner)

Method Summary

Modifier and Type	Method	Description
JCommentPart	addDeprecated()	add an @deprecated tag to the javadoc, with the associated message.
JCommentPart	addParam(JVar param)	Append a text to an @param tag.
JCommentPart	addParam(String param)	Append a text to a @param tag to the javadoc
JCommentPart	addReturn()	Appends a text to @return tag.
JCommentPart	addThrows(JClass exception)	add an @throws tag to the javadoc
JCommentPart	addThrows(Class<? extends Throwable> exception)	add an @throws tag to the javadoc
Map<String,String>	addXdoclet(String name)	add an xdoclet.
Map<String,String>	addXdoclet(String name, String attribute, String value)	add an xdoclet.
Map<String,String>	addXdoclet(String name, Map<String,String> attributes)	add an xdoclet.
JDocComment	append(Object o)	Appends a new value.
void	generate(JFormatter f)

Methods inherited from class JCommentPart

add, format

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

atParams

private final Map<String, JCommentPart> atParams

list of @param tags

atXdoclets

private final Map<String, Map<String,String>> atXdoclets

list of xdoclets

atThrows

private final Map<JClass, JCommentPart> atThrows

list of @throws tags

atReturn

private JCommentPart atReturn

The @return tag part.

atDeprecated

private JCommentPart atDeprecated

The @deprecated tag

owner

private final JCodeModel owner

INDENT

private static final String INDENT

See Also:

• Constant Field Values

Constructor Details

JDocComment

public JDocComment(JCodeModel owner)

Method Details

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