Interface CodeComment

All Superinterfaces:

CodeItem, CodeItemWithVariables, CodeStatement, Iterable<String>

All Known Subinterfaces:

CodeBlockComment, CodeComments, CodeInlineComment, CodeSingleComment, CodeSingleLineComment

public interface CodeComment
extends CodeStatement, Iterable<String>

CodeStatement for a comment.

Since:

1.0.0

Author:

hohwille

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
Iterable<String>	getCommentLines()
default CodeVariable	getVariable(String name)
default Iterator<String>	iterator()

Methods inherited from interface CodeItem

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

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getVariable

default CodeVariable getVariable(String name)

Specified by:

getVariable in interface CodeItemWithVariables

Parameters:

name - the name of the requested CodeVariable.

Returns:

the CodeVariable with the given name or null if not found.

iterator

default Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

getCommentLines

Iterable<String> getCommentLines()

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.).