net.grinder.util

Class FixedWidthFormatter

java.lang.Object

net.grinder.util.AbstractMultiLineFormatter

net.grinder.util.FixedWidthFormatter

All Implemented Interfaces:

MultiLineFormatter

public final class FixedWidthFormatter
extends AbstractMultiLineFormatter

MultiLineFormatter for fixed width text cells.

All white space is converted to plain spaces.

When flow policy is WORD_WRAP, newlines in the source are treated as preferred line breaks.

Author:

Philip Aston

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixedWidthFormatter.Align Alignment constants.
static class	FixedWidthFormatter.Flow Flow constants.

Constructor Summary

Constructors

Constructor and Description
FixedWidthFormatter(FixedWidthFormatter.Align alignment, FixedWidthFormatter.Flow flow, int width) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	transform(StringBuilder buffer, StringBuilder remainder) Alter buffer to contain a single line according to the policy of the formatter.

Methods inherited from class net.grinder.util.AbstractMultiLineFormatter

format

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedWidthFormatter

public FixedWidthFormatter(FixedWidthFormatter.Align alignment,
                   FixedWidthFormatter.Flow flow,
                   int width)

Constructor.

Parameters:

alignment - Alignment policy. One of { ALIGN_LEFT, ALIGN_CENTRE, ALIGN_RIGHT }

flow - Flow policy. One of { FLOW_TRUNCATE, FLOW_WRAP, FLOW_WORD_WRAP, FLOW_OVERFLOW }

width - The cell width.

Method Detail

transform

public void transform(StringBuilder buffer,
             StringBuilder remainder)

Alter buffer to contain a single line according to the policy of the formatter. Insert remaining text at the start of remainder.

Parameters:

buffer - Buffer to transform to a single line.

remainder - Leftovers.