Class LineWrapper

java.lang.Object

com.squareup.javapoet.LineWrapper

final class LineWrapper
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	LineWrapper.FlushType
(package private) static final class	LineWrapper.RecordingAppendable	A delegating Appendable that records info about the chars passing through it.

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	buffer	Characters written since the last wrapping space that haven't yet been flushed.
private boolean	closed
private int	column	The number of characters since the most recent newline.
private final int	columnLimit
private final String	indent
private int	indentLevel	-1 if we have no buffering; otherwise the number of indents to write after wrapping.
private LineWrapper.FlushType	nextFlush	Null if we have no buffering; otherwise the type to pass to the next call to flush(LineWrapper.FlushType).
private final LineWrapper.RecordingAppendable	out

Constructor Summary

Constructors

Constructor	Description
LineWrapper(Appendable out, String indent, int columnLimit)

Method Summary

Modifier and Type	Method	Description
(package private) void	append(String s)	Emit s.
(package private) void	close()	Flush any outstanding text and forbid future writes to this line wrapper.
private void	flush(LineWrapper.FlushType flushType)	Write the space followed by any buffered text that follows it.
(package private) char	lastChar()
(package private) void	wrappingSpace(int indentLevel)	Emit either a space or a newline character.
(package private) void	zeroWidthSpace(int indentLevel)	Emit a newline character if the line will exceed it's limit, otherwise do nothing.

Methods inherited from class Object

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

Field Details

out

private final LineWrapper.RecordingAppendable out

indent

private final String indent

columnLimit

private final int columnLimit

closed

private boolean closed

buffer

private final StringBuilder buffer

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

column

private int column

The number of characters since the most recent newline. Includes both out and the buffer.

indentLevel

private int indentLevel

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

nextFlush

private LineWrapper.FlushType nextFlush

Null if we have no buffering; otherwise the type to pass to the next call to flush(LineWrapper.FlushType).

Constructor Details

LineWrapper

LineWrapper(Appendable out,
 String indent,
 int columnLimit)

Method Details

lastChar

char lastChar()

Returns:

the last emitted char or Character.MIN_VALUE if nothing emitted yet.

append

void append(String s)
     throws IOException

Emit s. This may be buffered to permit line wraps to be inserted.

Throws:

IOException

wrappingSpace

void wrappingSpace(int indentLevel)
            throws IOException

Emit either a space or a newline character.

Throws:

IOException

zeroWidthSpace

void zeroWidthSpace(int indentLevel)
             throws IOException

Emit a newline character if the line will exceed it's limit, otherwise do nothing.

Throws:

IOException

close

void close()
    throws IOException

Flush any outstanding text and forbid future writes to this line wrapper.

Throws:

IOException

flush

private void flush(LineWrapper.FlushType flushType)
            throws IOException

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

Throws:

IOException