Interface CodeSingleComment

All Superinterfaces:

CodeComment, CodeItem, CodeItemWithVariables, CodeStatement, Iterable<String>

All Known Subinterfaces:

CodeInlineComment, CodeSingleLineComment

public interface CodeSingleComment
extends CodeComment

CodeComment for a single comment such as CodeSingleLineComment or CodeInlineComment.

Since:

1.0.0

Author:

hohwille

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
String	getComment()
default List<String>	getCommentLines()

Methods inherited from interface CodeComment

getVariable, iterator

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getComment

String getComment()

Returns:

the single comment (excluding any comment markup like "//", "/*", or "*/". Should not contain newline character(s).

getCommentLines

default List<String> getCommentLines()

Specified by:

getCommentLines in interface CodeComment

Returns:

the List of comment lines. Will always have the size 1 in case of CodeSingleLineComment. Each contained String will be the pure comment without leading comment prefix ("// ", "/* ", etc.).