net.mdatools.modelant.core.operation.format

Class FormatWrapText

java.lang.Object

net.mdatools.modelant.core.operation.format.FormatWrapText

All Implemented Interfaces:

Function<String,String>

Direct Known Subclasses:

FormatWrapTextJavaDoc

public class FormatWrapText
extends Object
implements Function<String,String>

Wrap the provided text by adding the prefix to all lines. If the text is empty, defaultVal is returned.

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields inherited from interface net.mdatools.modelant.core.api.Function

IDENTITY

Constructor Summary

Constructors

Constructor and Description
FormatWrapText() Wrap the paragraphs to 105 characters terminated by system-specific line separator without any prefix and default value.
FormatWrapText(String prefix, String defaultVal) Wrap the paragraphs to 105 characters terminated by "line.separator"
FormatWrapText(String prefix, String defaultVal, int maxLineLength) Wrap the paragraphs to maxLineLength characters terminated by "line.separator"
FormatWrapText(String prefix, String defaultVal, int maxLineLength, String lineSeparator) Wrap the paragraphs to maxLineLength characters terminated by lineSeparator

Method Summary

Modifier and Type	Method and Description
String	execute(String line) Adds the prefix to all lines and replaces the line terminators LF or CR LF with the system specific line terminator (CR LF or LF only).

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.api.Function

toString

Constructor Detail

FormatWrapText

public FormatWrapText()

Wrap the paragraphs to 105 characters terminated by system-specific line separator without any prefix and default value.

FormatWrapText

public FormatWrapText(String prefix,
                      String defaultVal)

Wrap the paragraphs to 105 characters terminated by "line.separator"

Parameters:

prefix - not null is prefix to be inserted in the beginning of each new line

defaultVal - non null is the value to prefix the first line

FormatWrapText

public FormatWrapText(String prefix,
                      String defaultVal,
                      int maxLineLength)

Wrap the paragraphs to maxLineLength characters terminated by "line.separator"

Parameters:

prefix - not null is prefix to be inserted in the beginning of each new line

defaultVal - non null is the value to prefix the first line

maxLineLength - > 0

FormatWrapText

public FormatWrapText(String prefix,
                      String defaultVal,
                      int maxLineLength,
                      String lineSeparator)

Wrap the paragraphs to maxLineLength characters terminated by lineSeparator

Parameters:

prefix - not null is prefix to be inserted in the beginning of each new line

defaultVal - non null is the value to prefix the first line

maxLineLength - > 0

lineSeparator - not null

Method Detail

execute

public final String execute(String line)

Adds the prefix to all lines and replaces the line terminators LF or CR LF with the system specific line terminator (CR LF or LF only). If the line is empty, defaultVal is returned.

Specified by:

execute in interface Function<String,String>

Parameters:

line - to format

Returns:

a string where all new lines (including the first one) are prefixed with the prefix string