Package com.github.tadukoo.java.comment

Class JavaMultiLineCommentBuilder<CommentType extends JavaMultiLineComment>

java.lang.Object

com.github.tadukoo.java.comment.JavaMultiLineCommentBuilder<CommentType>

Type Parameters:

CommentType - The type of JavaMultiLineComment being built

Direct Known Subclasses:

EditableJavaMultiLineComment.EditableJavaMultiLineCommentBuilder, UneditableJavaMultiLineComment.UneditableJavaMultiLineCommentBuilder

public abstract class JavaMultiLineCommentBuilder<CommentType extends JavaMultiLineComment>
extends Object

A builder used to build a multi-line comment. It takes the following parameters:

Java Multi-Line Comment Parameters

Parameter Name	Description	Default or Required
content	The content of the comment	An empty list

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	content	The content of the comment

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaMultiLineCommentBuilder()	Can only instantiate from subclasses

Method Summary

Modifier and Type	Method	Description
CommentType	build()	Builds a comment based on the set parameters
protected abstract CommentType	constructComment()	Used by subclasses to actually build the comment
JavaMultiLineCommentBuilder<CommentType>	content(String content)
JavaMultiLineCommentBuilder<CommentType>	content(List<String> content)
JavaMultiLineCommentBuilder<CommentType>	copy(JavaMultiLineComment comment)	Copies the settings from the given comment to this builder

Methods inherited from class java.lang.Object

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

Field Details

content

protected List<String> content

The content of the comment

Constructor Details

JavaMultiLineCommentBuilder

protected JavaMultiLineCommentBuilder()

Can only instantiate from subclasses

Method Details

copy

public JavaMultiLineCommentBuilder<CommentType> copy(JavaMultiLineComment comment)

Copies the settings from the given comment to this builder

Parameters:

comment - The comment to copy settings from

Returns:

this, to continue building

content

public JavaMultiLineCommentBuilder<CommentType> content(String content)

Parameters:

content - A single line of content to add to the comment

Returns:

this, to continue building

content

public JavaMultiLineCommentBuilder<CommentType> content(List<String> content)

Parameters:

content - The content of the comment

Returns:

this, to continue building

constructComment

protected abstract CommentType constructComment()

Used by subclasses to actually build the comment

Returns:

The newly constructed comment

build

public CommentType build()

Builds a comment based on the set parameters

Returns:

The newly built comment