Class BaseComments

java.lang.Object

io.github.mmm.code.base.item.BaseItem

io.github.mmm.code.base.comment.BaseComment

io.github.mmm.code.base.comment.BaseComments

All Implemented Interfaces:

io.github.mmm.code.api.comment.CodeComment, io.github.mmm.code.api.comment.CodeComments, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithVariables, io.github.mmm.code.api.statement.CodeStatement, Iterable<String>

public class BaseComments
extends BaseComment
implements io.github.mmm.code.api.comment.CodeComments

Base implementation of CodeComments.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface io.github.mmm.code.api.item.CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Constructor Summary

Constructors

Constructor	Description
BaseComments(List<? extends io.github.mmm.code.api.comment.CodeComment> commentBlocks)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
List<? extends io.github.mmm.code.api.comment.CodeComment>	getCommentBlocks()
Iterable<String>	getCommentLines()

Methods inherited from class BaseItem

getOwningType, getSourceCode, getSpaces, toString, write

Methods inherited from class Object

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

Methods inherited from interface io.github.mmm.code.api.comment.CodeComment

getVariable, iterator

Methods inherited from interface io.github.mmm.code.api.item.CodeItem

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

BaseComments

public BaseComments(List<? extends io.github.mmm.code.api.comment.CodeComment> commentBlocks)

The constructor.

Parameters:

commentBlocks - the comment blocks.

Method Details

getCommentLines

public Iterable<String> getCommentLines()

Specified by:

getCommentLines in interface io.github.mmm.code.api.comment.CodeComment

getCommentBlocks

public List<? extends io.github.mmm.code.api.comment.CodeComment> getCommentBlocks()

Specified by:

getCommentBlocks in interface io.github.mmm.code.api.comment.CodeComments

doWrite

protected void doWrite(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 io.github.mmm.code.api.language.CodeLanguage language)
                throws IOException

Specified by:

doWrite in class BaseItem

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

Throws:

IOException - if thrown by Appendable.

See Also:

• CodeItem.write(Appendable, String, String)