com.helger.jcodemodel

Class JDocComment

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

com.helger.jcodemodel.JCommentPart

com.helger.jcodemodel.JDocComment

All Implemented Interfaces:

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

public class JDocComment
extends JCommentPart
implements IJGenerable, IJOwned

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

Modifier	Constructor and Description
protected	JDocComment(JCodeModel owner)

Method Summary

Methods

Modifier and Type	Method and Description
JCommentPart	addAuthor() Appends a text to @author tag.
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(AbstractJClass 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, Map<String,String> attributes) add an xdoclet.
Map<String,String>	addXdoclet(String name, String attribute, String value) add an xdoclet.
JDocComment	append(Object o) Appends a new value.
void	generate(JFormatter f)
JCommentPart	getParam(JVar param)
JCommentPart	getParam(String param)
JCommentPart	getThrows(AbstractJClass exception)
JCommentPart	getThrows(Class<? extends Throwable> exception)
JCodeModel	owner() Gets the owner code model object.
void	removeAllParams()
void	removeAllThrows()
void	removeAllXdoclets()
void	removeAuthor()
void	removeDeprecated()
JCommentPart	removeParam(JVar param)
JCommentPart	removeParam(String param)
void	removeReturn()
JCommentPart	removeThrows(AbstractJClass exception)
JCommentPart	removeThrows(Class<? extends Throwable> exception)
Map<String,String>	removeXdoclet(String name)

Methods inherited from class com.helger.jcodemodel.JCommentPart

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

JDocComment

protected JDocComment(@Nonnull
           JCodeModel owner)

Method Detail

owner

@Nonnull
public JCodeModel owner()

Description copied from interface: IJOwned

Gets the owner code model object.

Specified by:

owner in interface IJOwned

Returns:

The owner and never null.

append

public JDocComment append(@Nullable
                 Object o)

Description copied from class: JCommentPart

Appends a new value.

Overrides:

append in class JCommentPart

Parameters:

o - If the value is AbstractJType it will be printed as a @link tag. Otherwise it will be converted to String via Object.toString().

Returns:

this for chaining

addParam

@Nonnull
public JCommentPart addParam(String param)

Append a text to a @param tag to the javadoc

Parameters:

param - Parameter to be added

Returns:

The created JCommentPart

addParam

public JCommentPart addParam(@Nonnull
                    JVar param)

Append a text to an @param tag.

Parameters:

param - Parameter to be added

Returns:

The created JCommentPart

removeParam

@Nullable
public JCommentPart removeParam(String param)

removeParam

@Nullable
public JCommentPart removeParam(@Nonnull
                                JVar param)

removeAllParams

public void removeAllParams()

getParam

@Nullable
public JCommentPart getParam(@Nullable
                             String param)

getParam

@Nullable
public JCommentPart getParam(@Nonnull
                             JVar param)

addThrows

public JCommentPart addThrows(@Nonnull
                     Class<? extends Throwable> exception)

add an @throws tag to the javadoc

Parameters:

exception - Exception to be added

Returns:

New JCommentPart

addThrows

public JCommentPart addThrows(AbstractJClass exception)

add an @throws tag to the javadoc

Parameters:

exception - Exception to be added

Returns:

New JCommentPart

removeThrows

@Nullable
public JCommentPart removeThrows(@Nonnull
                                 Class<? extends Throwable> exception)

removeThrows

@Nullable
public JCommentPart removeThrows(AbstractJClass exception)

removeAllThrows

public void removeAllThrows()

getThrows

@Nullable
public JCommentPart getThrows(@Nonnull
                              Class<? extends Throwable> exception)

getThrows

@Nullable
public JCommentPart getThrows(AbstractJClass exception)

addReturn

@Nonnull
public JCommentPart addReturn()

Appends a text to @return tag.

Returns:

Always the same JCommentPart

removeReturn

public void removeReturn()

addAuthor

@Nonnull
public JCommentPart addAuthor()

Appends a text to @author tag.

Returns:

Always the same JCommentPart

removeAuthor

public void removeAuthor()

addDeprecated

@Nonnull
public JCommentPart addDeprecated()

add an @deprecated tag to the javadoc, with the associated message.

Returns:

Always the same JCommentPart

removeDeprecated

public void removeDeprecated()

addXdoclet

@Nonnull
public Map<String,String> addXdoclet(String name)

add an xdoclet.

Parameters:

name - xdoclet name

Returns:

Map with the key/value pairs

addXdoclet

@Nonnull
public Map<String,String> addXdoclet(String name,
                                    Map<String,String> attributes)

add an xdoclet.

Parameters:

name - xdoclet name

attributes - Attributes to be added

Returns:

Map with the key/value pairs

addXdoclet

@Nonnull
public Map<String,String> addXdoclet(String name,
                                    String attribute,
                                    String value)

add an xdoclet.

Parameters:

name - xdoclet name

attribute - Attribute name to be added

value - Attribute value to be added

Returns:

Map with the key/value pairs

removeXdoclet

@Nullable
public Map<String,String> removeXdoclet(String name)

removeAllXdoclets

public void removeAllXdoclets()

generate

public void generate(@Nonnull
            JFormatter f)

Specified by:

generate in interface IJGenerable