Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	LineWrapper.FlushType
pack-priv static class	LineWrapper.RecordingAppendable A delegating `Appendable` that records info about the chars passing through it.

Modifier and Type	Field and 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 `indent`s 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`.
private final LineWrapper.RecordingAppendable	out

Constructor Summary

Access	Constructor and Description
pack-priv	LineWrapper(Appendable out, String indent, int columnLimit)

Method Summary

Modifier and Type	Method and Description
pack-priv void	append(String s) Emit `s`.
pack-priv 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.
pack-priv char	Returns: the last emitted char or `Character#MIN_VALUE` if nothing emitted yet. lastChar()
pack-priv void	wrappingSpace(int indentLevel) Emit either a space or a newline character.
pack-priv void	zeroWidthSpace(int indentLevel) Emit a newline character if the line will exceed it's limit, otherwise do nothing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buffer	back to summary
private final StringBuilder buffer Characters written since the last wrapping space that haven't yet been flushed.

closed	back to summary
private boolean closed

column	back to summary
private int column The number of characters since the most recent newline. Includes both out and the buffer.

columnLimit	back to summary
private final int columnLimit

indent	back to summary
private final String indent

indentLevel	back to summary
private int indentLevel -1 if we have no buffering; otherwise the number of `indent`s to write after wrapping.

nextFlush	back to summary
private LineWrapper.FlushType nextFlush Null if we have no buffering; otherwise the type to pass to the next call to `flush`.

out	back to summary
private final LineWrapper.RecordingAppendable out

Constructor Detail

LineWrapper	back to summary
pack-priv LineWrapper(Appendable out, String indent, int columnLimit)

Method Detail

append	back to summary
pack-priv void append(String s) throws IOException Emit `s`. This may be buffered to permit line wraps to be inserted.

close	back to summary
pack-priv void close() throws IOException Flush any outstanding text and forbid future writes to this line wrapper.

flush	back to summary
private void flush(LineWrapper.FlushType flushType) throws IOException Write the space followed by any buffered text that follows it.

lastChar	back to summary
pack-priv char lastChar() Returns:char the last emitted char or `Character#MIN_VALUE` if nothing emitted yet.

wrappingSpace	back to summary
pack-priv void wrappingSpace(int indentLevel) throws IOException Emit either a space or a newline character.

zeroWidthSpace	back to summary
pack-priv void zeroWidthSpace(int indentLevel) throws IOException Emit a newline character if the line will exceed it's limit, otherwise do nothing.

com.squareup.javapoet back to summary

private final Enum LineWrapper.FlushType

Class Inheritance

extends Enum<LineWrapper.FlushType>

java.lang.Object
java.lang.Enum
com.squareup.javapoet.LineWrapper.FlushType

Field Summary

Modifier and Type	Field and Description
public static final LineWrapper.FlushType	EMPTY
public static final LineWrapper.FlushType	SPACE
public static final LineWrapper.FlushType	WRAP

Constructor Summary

Access	Constructor and Description
private	FlushType()

Method Summary

Modifier and Type	Method and Description
public static LineWrapper.FlushType	valueOf(String name)
public static LineWrapper.FlushType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EMPTY	back to summary
public static final LineWrapper.FlushType EMPTY

SPACE	back to summary
public static final LineWrapper.FlushType SPACE

WRAP	back to summary
public static final LineWrapper.FlushType WRAP

Constructor Detail

FlushType	back to summary
private FlushType()

Method Detail

valueOf	back to summary
public static LineWrapper.FlushType valueOf(String name)

values	back to summary
public static LineWrapper.FlushType[] values()

com.squareup.javapoet back to summary

pack-priv final Class LineWrapper.RecordingAppendable

Class Inheritance

extends Object
implements Appendable

java.lang.Object
com.squareup.javapoet.LineWrapper.RecordingAppendable

All Implemented Interfaces

java.lang.Appendable

A delegating Appendable that records info about the chars passing through it.

Field Summary

Modifier and Type	Field and Description
private final Appendable	delegate
pack-priv char	lastChar

Constructor Summary

Access	Constructor and Description
pack-priv	RecordingAppendable(Appendable delegate)

Method Summary

Modifier and Type	Method and Description
public Appendable	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this Appendable. csq) Implements java.lang.Appendable.append. Appends the specified character sequence to this `Appendable`.
public Appendable	append(CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. csq, int The index of the first character in the subsequence start, int The index of the character following the last character in the subsequence end) Implements java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this `Appendable`.
public Appendable	append(char The character to append c) Implements java.lang.Appendable.append. Appends the specified character to this `Appendable`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final Appendable delegate

lastChar	back to summary
pack-priv char lastChar

Constructor Detail

RecordingAppendable	back to summary
pack-priv RecordingAppendable(Appendable delegate)

Method Detail

append back to summary

append	back to summary
public Appendable append(CharSequence csq) throws IOException Implements java.lang.Appendable.append. Doc from java.lang.Appendable.append. Appends the specified character sequence to this `Appendable`. Depending on which class implements the character sequence `csq`, the entire sequence may not be appended. For instance, if `csq` is a `java.nio.CharBuffer` then the subsequence to append is defined by the buffer's position and limit. Parameters csq:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this Appendable. Returns:Appendable A reference to this `Appendable` Annotations @Override Exceptions IOException: If an I/O error occurs

public Appendable append(CharSequence csq) throws IOException

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends the specified character sequence to this Appendable.

Depending on which class implements the character sequence csq, the entire sequence may not be appended. For instance, if csq is a java.nio.CharBuffer then the subsequence to append is defined by the buffer's position and limit.

Parameters

csq:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this Appendable.

Returns:Appendable

A reference to this Appendable

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

append back to summary

append	back to summary
public Appendable append(CharSequence csq, int start, int end) throws IOException Implements java.lang.Appendable.append. Doc from java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this `Appendable`. An invocation of this method of the form `out.append(csq, start, end)` when `csq` is not `null`, behaves in exactly the same way as the invocation out.append(csq.subSequence(start, end)) Parameters csq:CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. start:int The index of the first character in the subsequence end:int The index of the character following the last character in the subsequence Returns:Appendable A reference to this `Appendable` Annotations @Override Exceptions IOException: If an I/O error occurs

public Appendable append(CharSequence csq, int start, int end) throws IOException

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends a subsequence of the specified character sequence to this Appendable.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

    out.append(csq.subSequence(start, end))

Parameters

csq:CharSequence: The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
start:int: The index of the first character in the subsequence
end:int: The index of the character following the last character in the subsequence

Returns:Appendable

A reference to this Appendable

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

append back to summary

append	back to summary
public Appendable append(char c) throws IOException Implements java.lang.Appendable.append. Doc from java.lang.Appendable.append. Appends the specified character to this `Appendable`. Parameters c:char The character to append Returns:Appendable A reference to this `Appendable` Annotations @Override Exceptions IOException: If an I/O error occurs

public Appendable append(char c) throws IOException

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends the specified character to this Appendable.

Parameters

c:char: The character to append

Returns:Appendable

A reference to this Appendable

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs