Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class LineWrapper

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.LineWrapper

All Implemented Interfaces:

Closeable, AutoCloseable

@ClassVersion(sourceVersion="$Id: LineWrapper.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class LineWrapper
extends Object
implements Closeable

Implements soft line wrapping on an Appendable. To use, append characters using append(CharSequence) or soft-wrapping spaces using wrappingSpace(int).

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: LineWrapper.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.LineWrapper"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	LineWrapper.FlushType	The flush types.

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	m_Buffer	Characters written since the last wrapping space that haven't yet been flushed.
private boolean	m_Closed	The flag that indicates whether this line wrapper was already closed.
private int	m_Column	The number of characters since the most recent newline.
private final int	m_ColumnLimit	The maximum line length.
private final String	m_Indent	The indentation String.
private int	m_IndentLevel	-1 if we have no buffering; otherwise the number of m_Indents to write after wrapping.
private LineWrapper.FlushType	m_NextFlush	null if we have no buffering; otherwise the type to pass to the next call to flush(org.tquadrat.foundation.javacomposer.internal.LineWrapper.FlushType).
private final Appendable	m_Out	The output target.

Constructor Summary

Constructors

Constructor	Description
LineWrapper(Appendable out, String indent, int columnLimit)	Creates a new LineWrapper instance.

Method Summary

Modifier and Type	Method	Description
final void	append(CharSequence input)	Emits the given String.
final void	close()	This implementation flushes any outstanding text and forbid future writes to this line wrapper.
private final void	flush(LineWrapper.FlushType flushType)	Writes the space followed by any buffered text that follows it.
final void	wrappingSpace(int indentLevel)	Emits either a space or a newline character.
final void	zeroWidthSpace(int indentLevel)	Emits a newline character if the line will exceed its limit, otherwise do nothing.

Methods inherited from class java.lang.Object

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

Field Details

m_Buffer

private final StringBuilder m_Buffer

Characters written since the last wrapping space that haven't yet been flushed.

m_Closed

private boolean m_Closed

The flag that indicates whether this line wrapper was already closed.

m_Column

private int m_Column

The number of characters since the most recent newline. Includes both m_Out and m_Buffer.

m_ColumnLimit

private final int m_ColumnLimit

The maximum line length.

m_Indent

private final String m_Indent

The indentation String.

m_IndentLevel

private int m_IndentLevel

-1 if we have no buffering; otherwise the number of m_Indents to write after wrapping.

m_NextFlush

private LineWrapper.FlushType m_NextFlush

null if we have no buffering; otherwise the type to pass to the next call to flush(org.tquadrat.foundation.javacomposer.internal.LineWrapper.FlushType).

m_Out

private final Appendable m_Out

The output target.

Constructor Details

LineWrapper

public LineWrapper(Appendable out,
 String indent,
 int columnLimit)

Creates a new LineWrapper instance.

Parameters:

out - The output target.

indent - The indentation string.

columnLimit - The maximum line length.

Method Details

append

public final void append(CharSequence input)
                  throws IOException

Emits the given String. This may be buffered to permit line wraps to be inserted.

Parameters:

input - The string to emit.

Throws:

IOException - A problem occurred when writing to the output target.

close

public final void close()
                 throws IOException

This implementation flushes any outstanding text and forbid future writes to this line wrapper.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

private final void flush(LineWrapper.FlushType flushType)
                  throws IOException

Writes the space followed by any buffered text that follows it.

Parameters:

flushType - The flush type.

Throws:

IOException - A problem occurred when writing to the output target.

wrappingSpace

public final void wrappingSpace(int indentLevel)
                         throws IOException

Emits either a space or a newline character.

Parameters:

indentLevel - The indentation level.

Throws:

IOException - A problem occurred when writing to the output target.

zeroWidthSpace

public final void zeroWidthSpace(int indentLevel)
                          throws IOException

Emits a newline character if the line will exceed its limit, otherwise do nothing.

Parameters:

indentLevel - The indentation level.

Throws:

IOException - A problem occurred when writing to the output target.