Package com.github.tadukoo.java.comment

Class JavaMultiLineComment

java.lang.Object

com.github.tadukoo.java.comment.JavaMultiLineComment

All Implemented Interfaces:

JavaCodeType, JavaTokens

Direct Known Subclasses:

EditableJavaMultiLineComment, UneditableJavaMultiLineComment

public abstract class JavaMultiLineComment
extends Object
implements JavaCodeType

Represents a multi-line comment in Java code

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

Fields inherited from interface com.github.tadukoo.java.JavaCodeType

NEWLINE_WITH_2_TABS, NEWLINE_WITH_4_TABS

Fields inherited from interface com.github.tadukoo.java.JavaTokens

ABSTRACT_MODIFIER, ANNOTATION_START_TOKEN, ASSIGNMENT_OPERATOR_TOKEN, BLOCK_CLOSE_TOKEN, BLOCK_OPEN_TOKEN, CLASS_TOKEN, EXTENDS_TOKEN, FINAL_MODIFIER, IMPLEMENTS_TOKEN, IMPORT_TOKEN, JAVADOC_AUTHOR_TOKEN, JAVADOC_LINE_TOKEN, JAVADOC_PARAM_TOKEN, JAVADOC_RETURN_TOKEN, JAVADOC_SINCE_TOKEN, JAVADOC_START_TOKEN, JAVADOC_VERSION_TOKEN, LIST_SEPARATOR_TOKEN, MODIFIERS, MULTI_LINE_COMMENT_CLOSE_TOKEN, MULTI_LINE_COMMENT_START_TOKEN, PACKAGE_TOKEN, PARAMETER_CLOSE_TOKEN, PARAMETER_OPEN_TOKEN, PRIVATE_MODIFIER, PROTECTED_MODIFIER, PUBLIC_MODIFIER, SEMICOLON, SINGLE_LINE_COMMENT_TOKEN, STATIC_MODIFIER, THROWS_TOKEN, TYPE_PARAMETER_CLOSE_TOKEN, TYPE_PARAMETER_OPEN_TOKEN, VARARGS_TOKEN, VISIBILITY_MODIFIERS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaMultiLineComment(boolean editable, List<String> content)	Constructs a new JavaMultiLineComment with the given parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<String>	getContent()
JavaCodeTypes	getJavaCodeType()
boolean	isEditable()
String	toBuilderCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tadukoo.java.JavaCodeType

escapeQuotes

Field Details

content

protected List<String> content

The content of the comment

Constructor Details

JavaMultiLineComment

protected JavaMultiLineComment(boolean editable,
 List<String> content)

Constructs a new JavaMultiLineComment with the given parameters

Parameters:

editable - Whether this comment is editable or not

content - The content of the comment

Method Details

getJavaCodeType

public JavaCodeTypes getJavaCodeType()

Specified by:

getJavaCodeType in interface JavaCodeType

Returns:

What type this is

isEditable

public boolean isEditable()

Returns:

Whether this comment is editable or not

getContent

public List<String> getContent()

Returns:

The content of the comment

toString

public String toString()

Overrides:

toString in class Object

Returns:

This multi-line comment as a string

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toBuilderCode

public String toBuilderCode()

Specified by:

toBuilderCode in interface JavaCodeType

Returns:

The String of code to build the JavaCodeType