org.springframework.roo.classpath.details.comments

Class JavadocComment

java.lang.Object

org.springframework.roo.classpath.details.comments.AbstractComment

org.springframework.roo.classpath.details.comments.JavadocComment

public class JavadocComment
extends AbstractComment

= JavadocComment Holds a full JavaDoc comment which can be added to a CommentStructure This class is responsible of adding the right JavaDoc syntax in its proper place inside the structure. Having this in mind, adding manually any syntax *is discouraged*. Please, avoid using specific system line separators. Use `org.apache.commons.io.IOUtils.LINE_SEPARATOR` to specify line breaks.

Author:

Mike De Haan, Sergio Clares, Jose Manuel Vivó

Constructor Summary

Constructors

Constructor and Description
JavadocComment() Default empty constructor.
JavadocComment(String comment) Used to add the full JavaDoc comment during the instantiation.
JavadocComment(String description, ConstructorMetadata constructor) Constructor used to generate full javadoc for a constructor
JavadocComment(String description, List<String> paramsInfo, String returnInfo, List<String> throwsTypes) Constructor used to generate a full Javadoc with description, params, return and throws.
JavadocComment(String description, MethodMetadata method) Constructor used to generate full javadoc for a method

Method Summary

Modifier and Type	Method and Description
static CommentStructure	create(ConstructorMetadata constructor, String messageFormat, Object... args) Create a CommentStructure with a JavaDoc for constructor with message using String.format(String, Object...) function
static CommentStructure	create(MethodMetadata metadata, String messageFormat, Object... args) Create a CommentStructure with a JavaDoc for method with message using String.format(String, Object...) function
static CommentStructure	create(String messageFormat, Object... args) Create a CommentStructure with a JavaDoc with message using String.format(String, Object...) function
String	getDescription()
List<String>	getParamsInfo()
String	getReturnInfo()
List<String>	getThrowsInfo()
protected void	loadFromDefinitions()
void	setComment(String comment)
void	setDescription(String description)
void	setParamsInfo(List<String> paramsInfo)
void	setReturnInfo(String returnInfo)
void	setThrowsInfo(List<String> throwsInfo)

Methods inherited from class org.springframework.roo.classpath.details.comments.AbstractComment

getComment, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JavadocComment

public JavadocComment()

Default empty constructor.

JavadocComment

public JavadocComment(String comment)

Used to add the full JavaDoc comment during the instantiation. The comment will be checked and formatted with the JavaDoc syntax before setting it. Line breaks will be taken in count in order to form the syntax.

Parameters:

comment - the String with the comment to add as JavaDoc syntax.

JavadocComment

public JavadocComment(String description,
                      MethodMetadata method)

Constructor used to generate full javadoc for a method

Parameters:

description -

method -

JavadocComment

public JavadocComment(String description,
                      ConstructorMetadata constructor)

Constructor used to generate full javadoc for a constructor

Parameters:

description -

constructor -

JavadocComment

public JavadocComment(String description,
                      List<String> paramsInfo,
                      String returnInfo,
                      List<String> throwsTypes)

Constructor used to generate a full Javadoc with description, params, return and throws. `null` arguments are accepted. JavaDoc comment block syntax will be auto-generated. ROO-3862: Improve JavaDoc generation for generated methods and constructors

Parameters:

description - the `String` with the block description to add. Please, use `org.apache.commons.io.IOUtils.LINE_SEPARATOR` for line breaks.

paramsInfo - the `List` with the parameter info. One entry for each parameter. JavaDoc ` * @param` syntax will be automatically added.

returnInfo - the `String` with the return info. JavaDoc ` * @return` syntax will be automatically added.

throwsInfo - the `List` with the throws info. One entry for each throws type. JavaDoc ` * @throws` syntax will be automatically added.

Method Detail

create

public static CommentStructure create(String messageFormat,
                                      Object... args)

Create a CommentStructure with a JavaDoc with message using String.format(String, Object...) function

Parameters:

message -

create

public static CommentStructure create(ConstructorMetadata constructor,
                                      String messageFormat,
                                      Object... args)

Create a CommentStructure with a JavaDoc for constructor with message using String.format(String, Object...) function

Parameters:

message -

create

public static CommentStructure create(MethodMetadata metadata,
                                      String messageFormat,
                                      Object... args)

Create a CommentStructure with a JavaDoc for method with message using String.format(String, Object...) function

Parameters:

message -

loadFromDefinitions

protected void loadFromDefinitions()

setComment

public void setComment(String comment)

Overrides:

setComment in class AbstractComment

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getParamsInfo

public List<String> getParamsInfo()

setParamsInfo

public void setParamsInfo(List<String> paramsInfo)

getReturnInfo

public String getReturnInfo()

setReturnInfo

public void setReturnInfo(String returnInfo)

getThrowsInfo

public List<String> getThrowsInfo()

setThrowsInfo

public void setThrowsInfo(List<String> throwsInfo)