org.davidmoten.text.utils

Class WordWrap.Builder

java.lang.Object

org.davidmoten.text.utils.WordWrap.Builder

Enclosing class:

WordWrap

public static final class WordWrap.Builder
extends Object

Provides method chaining for specifying parameters to word wrap.

Method Summary

Modifier and Type	Method and Description
WordWrap.Builder	breakWords(boolean breakWords) If a word is longer than maxWidth and breakWords is true then such a word will be broken across two or more lines (with or without a hyphen according to insertHyphens(boolean)).
WordWrap.Builder	excludeExtraWordChars(String excludeWordChars) Adds extra word characters to be excluded.
WordWrap.Builder	extraWordChars(Set<Character> extraWordChars) Sets all extra word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).
WordWrap.Builder	extraWordChars(String extraWordChars) Sets all extra word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).
WordWrap.Builder	includeExtraWordChars(String includeWordChars) Adds more word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).
WordWrap.Builder	insertHyphens(boolean insertHyphens) Sets if to break words using a hyphen character.
WordWrap.Builder	maxWidth(Number maxWidth) Sets the maximum width of a line using the stringWidth function.
WordWrap.Builder	newLine(String newLine) Sets the newLine string to be used.
WordWrap.Builder	stringWidth(Function<? super CharSequence,? extends Number> stringWidth) Sets the string width function used to determine if a line is at maximum width (and therefore needing wrapping or splitting).
String	wrap() Performs the wrapping of the source text and returns output as a String.
void	wrap(File file, Charset charset) Performs the wrapping of the source text and writes output to the given file with the given character set encoding.
void	wrap(LineConsumer consumer)
void	wrap(String filename, Charset charset) Performs the wrapping of the source text and writes the output to a file with the given filename using the given encoding.
void	wrap(Writer out) Performs the wrapping of the source text and writes output to the given Writer.
List<String>	wrapToList()
void	wrapUtf8(File file) Performs the wrapping of the source text and writes the output to the given file using UTF-8 encoding.
void	wrapUtf8(String filename) Performs the wrapping of the source text and writes the output to a file with the given filename.

Methods inherited from class java.lang.Object

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

Method Detail

maxWidth

public WordWrap.Builder maxWidth(Number maxWidth)

Sets the maximum width of a line using the stringWidth function. Word wrapping/splitting will be attempted for lines with greater than maxWidth. If not set the default is 80.

Parameters:

maxWidth - maximum width of a line using the stringWidth function.

Returns:

this

Throws:

IllegalArgumentException - if maxWidth is less than or equal to zero

stringWidth

public WordWrap.Builder stringWidth(Function<? super CharSequence,? extends Number> stringWidth)

Sets the string width function used to determine if a line is at maximum width (and therefore needing wrapping or splitting). If not set the string width function is the number of characters.

Parameters:

stringWidth - function that returns the width of a sequence of characters

Returns:

this

newLine

public WordWrap.Builder newLine(String newLine)

Sets the newLine string to be used. If not set the default is '\n' (line feed character).

Parameters:

newLine - string to be output on for a new line delimiter

Returns:

this

extraWordChars

public WordWrap.Builder extraWordChars(Set<Character> extraWordChars)

Sets all extra word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).

Parameters:

extraWordChars - extra word characters (in addtion to alphabetic characters)

Returns:

this

extraWordChars

public WordWrap.Builder extraWordChars(String extraWordChars)

Sets all extra word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).

Parameters:

extraWordChars - extra word characters (in addtion to alphabetic characters)

Returns:

this

includeExtraWordChars

public WordWrap.Builder includeExtraWordChars(String includeWordChars)

Adds more word characters (characters that will be treated like normal alphabetic characters for defining word boundaries).

Parameters:

includeWordChars - more word characters

Returns:

this

excludeExtraWordChars

public WordWrap.Builder excludeExtraWordChars(String excludeWordChars)

Adds extra word characters to be excluded. Alphabetic characters are always word characters and thus will be ignored here.

Parameters:

excludeWordChars - extra word characters to be excluded

Returns:

this

insertHyphens

public WordWrap.Builder insertHyphens(boolean insertHyphens)

Sets if to break words using a hyphen character. If set to false then no breaking character will be used.

Parameters:

insertHyphens - whether to break hyphens

Returns:

this

breakWords

public WordWrap.Builder breakWords(boolean breakWords)

If a word is longer than maxWidth and breakWords is true then such a word will be broken across two or more lines (with or without a hyphen according to insertHyphens(boolean)).

Parameters:

breakWords - if true then break words across lines

Returns:

this

wrap

public void wrap(Writer out)

Performs the wrapping of the source text and writes output to the given Writer.

Parameters:

out - output for wrapped text

wrapToList

public List<String> wrapToList()

wrap

public void wrap(LineConsumer consumer)

wrap

public void wrap(File file,
                 Charset charset)

Performs the wrapping of the source text and writes output to the given file with the given character set encoding.

Parameters:

file - file to receive wrapped output

charset - encoding to use for output

wrapUtf8

public void wrapUtf8(File file)

Performs the wrapping of the source text and writes the output to the given file using UTF-8 encoding.

Parameters:

file - output file for wrapped text

wrapUtf8

public void wrapUtf8(String filename)

Performs the wrapping of the source text and writes the output to a file with the given filename.

Parameters:

filename - output file for wrapped text

wrap

public void wrap(String filename,
                 Charset charset)

Performs the wrapping of the source text and writes the output to a file with the given filename using the given encoding.

Parameters:

filename - output file for the wrapped text

charset - encoding to use for output

wrap

public String wrap()

Performs the wrapping of the source text and returns output as a String.

Returns:

wrapped text