org.mule.devkit.model.code

Class GeneratedJavaDocComment

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

org.mule.devkit.model.code.CommentPart

org.mule.devkit.model.code.GeneratedJavaDocComment

All Implemented Interfaces:

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

public class GeneratedJavaDocComment
extends CommentPart
implements Generable

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

Constructors

Constructor and Description
GeneratedJavaDocComment(CodeModel owner)

Method Summary

Methods

Modifier and Type	Method and Description
CommentPart	addDeprecated() add an @deprecated tag to the javadoc, with the associated message.
CommentPart	addParam(GeneratedVariable param) Append a text to an @param tag.
CommentPart	addParam(String param) Append a text to a @param tag to the javadoc
CommentPart	addReturn(String ret) Appends a text to @return tag.
CommentPart	addThrows(Class<? extends Throwable> exception) add an @throws tag to the javadoc
CommentPart	addThrows(TypeReference 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.
GeneratedJavaDocComment	append(Object o) Appends a new value.
void	generate(Formatter f)

Methods inherited from class org.mule.devkit.model.code.CommentPart

add, format

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

GeneratedJavaDocComment

public GeneratedJavaDocComment(CodeModel owner)

Method Detail

append

public GeneratedJavaDocComment append(Object o)

Description copied from class: CommentPart

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

Overrides:

append in class CommentPart

addParam

public CommentPart addParam(String param)

Append a text to a @param tag to the javadoc

addParam

public CommentPart addParam(GeneratedVariable param)

Append a text to an @param tag.

addThrows

public CommentPart addThrows(Class<? extends Throwable> exception)

add an @throws tag to the javadoc

addThrows

public CommentPart addThrows(TypeReference exception)

add an @throws tag to the javadoc

addReturn

public CommentPart addReturn(String ret)

Appends a text to @return tag.

addDeprecated

public CommentPart 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(Formatter f)

Specified by:

generate in interface Generable