org.yarnandtail.andhow.sample

Class TextLine.HRLine

java.lang.Object

org.yarnandtail.andhow.sample.TextLine

org.yarnandtail.andhow.sample.TextLine.HRLine

Enclosing class:

TextLine

public static class TextLine.HRLine
extends TextLine

A horizontal rule / separator line.

Nested Class Summary

Nested classes/interfaces inherited from class org.yarnandtail.andhow.sample.TextLine

TextLine.BlankLine, TextLine.HRLine, TextLine.StringLine

Field Summary

Fields inherited from class org.yarnandtail.andhow.sample.TextLine

wrap

Constructor Summary

Constructors

Constructor and Description
HRLine()

Method Summary

Modifier and Type	Method and Description
String	getBlockComment(PrintFormat format, boolean startComment, boolean endComment) Within a comment block, write this single line as a block comment.
String	getLine(PrintFormat format)
String	getLineComment(PrintFormat format) Write this single line as a line comment.
List<String>	getWrappedBlockComment(PrintFormat format, boolean startComment, boolean endComment) Within a comment block, write this line and wrap it if it is too long.
List<String>	getWrappedLine(PrintFormat format) Wrap a line to the max line length.
List<String>	getWrappedLineComment(PrintFormat format) Wrap a line and format it as a line comment (not a block comment) Calling this on a format that doesn't have line comments (eg xml) results in a line that is not a comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

HRLine

public HRLine()

Method Detail

getLine

public String getLine(PrintFormat format)

getLineComment

public String getLineComment(PrintFormat format)

Description copied from class: TextLine

Write this single line as a line comment. The comment marker and the content of the line are separated by the format.lineCommentPrefixSeparator. Calling this on a format that doesn't have line comments (eg xml) results in a line that is not a comment.

Returns:

getBlockComment

public String getBlockComment(PrintFormat format,
                              boolean startComment,
                              boolean endComment)

Description copied from class: TextLine

Within a comment block, write this single line as a block comment. Calling this on a format that doesn't have block comments (eg properties files) result in uncommented text.

startComment - If true, this is the first block line, so write block start.

endComment - If true, this is the last block line, so write block end.

Returns:

getWrappedLine

public List<String> getWrappedLine(PrintFormat format)

Description copied from class: TextLine

Wrap a line to the max line length.

Returns:

getWrappedLineComment

public List<String> getWrappedLineComment(PrintFormat format)

Description copied from class: TextLine

Wrap a line and format it as a line comment (not a block comment) Calling this on a format that doesn't have line comments (eg xml) results in a line that is not a comment.

Returns:

getWrappedBlockComment

public List<String> getWrappedBlockComment(PrintFormat format,
                                           boolean startComment,
                                           boolean endComment)

Description copied from class: TextLine

Within a comment block, write this line and wrap it if it is too long. Calling this on a format that doesn't have block comments (eg properties files) result in uncommented text.

startComment - If true, this is the first block line, so write block start.

endComment - If true, this is the last block line, so write block end.

Returns: