org.seedstack.shed.text

Class TextWrapper

java.lang.Object

org.seedstack.shed.text.TextWrapper

public class TextWrapper
extends Object

Wrap text to the specified width using a greedy algorithm. A continuation symbol can be used when a long word doesn't fit on one line and must be broken apart.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTINUATION
static boolean	DEFAULT_STRICT_MODE
static int	DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor and Description
TextWrapper() Creates a text wrapper with the default options.
TextWrapper(int width) Creates a text wrapper with a custom line width.
TextWrapper(int width, String continuation) Creates a text wrapper with a custom line width and a custom continuation character.
TextWrapper(int width, String continuation, boolean strict) Creates a text wrapper with a custom line width, a custom continuation character and a specified strict mode.

Method Summary

Modifier and Type	Method and Description
String	wrap(String text) Wrap the specified text.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTINUATION

public static final String DEFAULT_CONTINUATION

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_STRICT_MODE

public static final boolean DEFAULT_STRICT_MODE

See Also:

Constant Field Values

Constructor Detail

TextWrapper

public TextWrapper()

Creates a text wrapper with the default options.

TextWrapper

public TextWrapper(int width)

Creates a text wrapper with a custom line width.

Parameters:

width - the line width.

TextWrapper

public TextWrapper(int width,
                   String continuation)

Creates a text wrapper with a custom line width and a custom continuation character.

Parameters:

width - the line width.

continuation - the continuation character.

TextWrapper

public TextWrapper(int width,
                   String continuation,
                   boolean strict)

Creates a text wrapper with a custom line width, a custom continuation character and a specified strict mode.

Parameters:

width - the line width.

continuation - the continuation character.

strict - if true, line width is strictly enforced, if false, single words are allowed to go beyond.

Method Detail

wrap

public String wrap(String text)

Wrap the specified text.

Parameters:

text - the text to wrap.

Returns:

the wrapped text.