Package com.github.tadukoo.java.comment

Class JavaSingleLineCommentBuilder<CommentType extends JavaSingleLineComment>

java.lang.Object

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

Type Parameters:

CommentType - The type of JavaSingleLineComment to be built

Direct Known Subclasses:

EditableJavaSingleLineComment.EditableJavaSingleLineCommentBuilder, UneditableJavaSingleLineComment.UneditableJavaSingleLineCommentBuilder

public abstract class JavaSingleLineCommentBuilder<CommentType extends JavaSingleLineComment>
extends Object

A builder used to build a JavaSingleLineComment. It takes the following parameters:

Single Line Comment Parameters

Parameter Name	Description	Default or Required
content	The content of the comment	Defaults to empty string

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaSingleLineCommentBuilder()	Constructs a new JavaSingleLineCommentBuilder

Method Summary

Modifier and Type	Method	Description
CommentType	build()	Builds the comment based on the set parameters
protected abstract CommentType	constructSingleLineComment()	Used by subclasses to actually construct the JavaSingleLineComment
JavaSingleLineCommentBuilder<CommentType>	content(String content)
JavaSingleLineCommentBuilder<CommentType>	copy(JavaSingleLineComment comment)	Copies the settings from the given comment into this builder

Methods inherited from class java.lang.Object

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

Field Details

content

protected String content

The content of the comment

Constructor Details

JavaSingleLineCommentBuilder

protected JavaSingleLineCommentBuilder()

Constructs a new JavaSingleLineCommentBuilder

Method Details

copy

public JavaSingleLineCommentBuilder<CommentType> copy(JavaSingleLineComment comment)

Copies the settings from the given comment into this builder

Parameters:

comment - The comment to copy settings from

Returns:

this, to continue building

content

public JavaSingleLineCommentBuilder<CommentType> content(String content)

Parameters:

content - The content of the comment

Returns:

this, to continue building

constructSingleLineComment

protected abstract CommentType constructSingleLineComment()

Used by subclasses to actually construct the JavaSingleLineComment

Returns:

The newly constructed JavaSingleLineComment

build

public CommentType build()

Builds the comment based on the set parameters

Returns:

The newly built comment