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, IJObject, 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

Modifier and Type	Field and Description
static String	TAG_AUTHOR
static String	TAG_DEPRECATED
static String	TAG_SEE
static String	TAG_SINCE
static String	TAG_VERSION

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDocComment(JCodeModel owner)

Method Summary

Modifier and Type	Method and Description
JCommentPart	addAuthor() Create an @author tag.
JCommentPart	addDeprecated() add a @deprecated tag to the javadoc, with the associated message.
JCommentPart	addParam(JVar sParam) Append a text to an @param tag.
JCommentPart	addParam(String sParam) Append a text to a @param tag to the javadoc
JCommentPart	addReturn() Appends a text to @return tag.
JCommentPart	addTag(String sName)
JCommentPart	addThrows(AbstractJClass aException) add a @throws tag to the javadoc
JCommentPart	addThrows(Class<? extends Throwable> aException) add a @throws tag to the javadoc
Map<String,String>	addXdoclet(String sName) add an xdoclet.
Map<String,String>	addXdoclet(String sName, Map<String,String> aAttributes) add an xdoclet.
Map<String,String>	addXdoclet(String sName, String sAttribute, String sValue) add an xdoclet with @name attribute = "value".
JDocComment	append(Object o) Appends a new value.
void	generate(JFormatter f)
JCommentPart	getParam(JVar aParam)
JCommentPart	getParam(String sParam)
JCommentPart	getReturn()
JCommentPart	getTag(String sName)
JCommentPart	getThrows(AbstractJClass aException)
JCommentPart	getThrows(Class<? extends Throwable> aException)
boolean	isSingleLineMode()
JCodeModel	owner() Gets the owner code model object.
void	removeAllParams()
void	removeAllThrows()
void	removeAllXdoclets()
void	removeAuthor()
void	removeDeprecated()
JCommentPart	removeParam(JVar aParam)
JCommentPart	removeParam(String sParam)
void	removeReturn()
JCommentPart	removeTag(String sName)
JCommentPart	removeThrows(AbstractJClass aException)
JCommentPart	removeThrows(Class<? extends Throwable> aException)
Map<String,String>	removeXdoclet(String name)
JDocComment	setSingleLineMode(boolean bSingleLineMode) Change whether multi line comments or single line comments should be emitted.

Methods inherited from class com.helger.jcodemodel.JCommentPart

add, format

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, 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

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

TAG_AUTHOR

public static final String TAG_AUTHOR

See Also:

Constant Field Values

TAG_DEPRECATED

public static final String TAG_DEPRECATED

See Also:

Constant Field Values

TAG_SEE

public static final String TAG_SEE

See Also:

Constant Field Values

TAG_SINCE

public static final String TAG_SINCE

See Also:

Constant Field Values

TAG_VERSION

public static final String TAG_VERSION

See Also:

Constant Field Values

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.

setSingleLineMode

@Nonnull
public JDocComment setSingleLineMode(boolean bSingleLineMode)

Change whether multi line comments or single line comments should be emitted.

Parameters:

bSingleLineMode - true to enable single line mode, false for multi line mode (which is the default).

Returns:

this for chaining

isSingleLineMode

public boolean isSingleLineMode()

Returns:

true if single line mode is enabled, false if multi line mode is enabled. Multi line mode is the default.

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(@Nonnull
                                       String sParam)

Append a text to a @param tag to the javadoc

Parameters:

sParam - Parameter to be added

Returns:

The created JCommentPart

addParam

public JCommentPart addParam(@Nonnull
                             JVar sParam)

Append a text to an @param tag.

Parameters:

sParam - Parameter to be added

Returns:

The created JCommentPart

removeParam

@Nullable
public JCommentPart removeParam(@Nullable
                                           String sParam)

removeParam

@Nullable
public JCommentPart removeParam(@Nonnull
                                           JVar aParam)

removeAllParams

public void removeAllParams()

getParam

@Nullable
public JCommentPart getParam(@Nullable
                                        String sParam)

getParam

@Nullable
public JCommentPart getParam(@Nonnull
                                        JVar aParam)

addReturn

@Nonnull
public JCommentPart addReturn()

Appends a text to @return tag.

Returns:

Always the same JCommentPart

getReturn

@Nullable
public JCommentPart getReturn()

removeReturn

public void removeReturn()

addThrows

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

add a @throws tag to the javadoc

Parameters:

aException - Exception to be added. May not be null.

Returns:

New JCommentPart

addThrows

@Nonnull
public JCommentPart addThrows(@Nonnull
                                        AbstractJClass aException)

add a @throws tag to the javadoc

Parameters:

aException - Exception to be added. May not be null.

Returns:

New JCommentPart

removeThrows

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

removeThrows

@Nullable
public JCommentPart removeThrows(@Nullable
                                            AbstractJClass aException)

removeAllThrows

public void removeAllThrows()

getThrows

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

getThrows

@Nullable
public JCommentPart getThrows(@Nullable
                                         AbstractJClass aException)

addTag

@Nonnull
public JCommentPart addTag(@Nonnull
                                     String sName)

removeTag

@Nullable
public JCommentPart removeTag(@Nullable
                                         String sName)

getTag

@Nullable
public JCommentPart getTag(@Nullable
                                      String sName)

addAuthor

@Nonnull
public JCommentPart addAuthor()

Create an @author tag.

Returns:

Always the same JCommentPart

See Also:

addTag(String)

removeAuthor

public void removeAuthor()

addDeprecated

@Nonnull
public JCommentPart addDeprecated()

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

Returns:

Always the same JCommentPart

See Also:

addTag(String)

removeDeprecated

public void removeDeprecated()

addXdoclet

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

add an xdoclet.

Parameters:

sName - xdoclet name

Returns:

Map with the key/value pairs

addXdoclet

@Nonnull
public Map<String,String> addXdoclet(@Nonnull
                                               String sName,
                                               @Nonnull
                                               Map<String,String> aAttributes)

add an xdoclet.

Parameters:

sName - xdoclet name

aAttributes - Attributes to be added

Returns:

Map with the key/value pairs

addXdoclet

@Nonnull
public Map<String,String> addXdoclet(@Nonnull
                                               String sName,
                                               @Nonnull
                                               String sAttribute,
                                               @Nullable
                                               String sValue)

add an xdoclet with @name attribute = "value". If value is null than it will be @name attribute.

Parameters:

sName - xdoclet name

sAttribute - Attribute name to be added

sValue - Attribute value to be added

Returns:

Map with the key/value pairs

removeXdoclet

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

removeAllXdoclets

public void removeAllXdoclets()

generate

public void generate(@Nonnull
                     JFormatter f)

Specified by:

generate in interface IJGenerable