com.palantir.javaformat.doc

Class Level

java.lang.Object

com.palantir.javaformat.doc.HasUniqueId

com.palantir.javaformat.doc.Doc

com.palantir.javaformat.doc.Level

public final class Level
extends Doc

A Level inside a Doc.

Method Summary

Modifier and Type	Method and Description
State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observer) Make breaking decisions for a Doc.
protected java.lang.String	computeFlat() Compute the Doc's flat value.
protected com.google.common.collect.Range<java.lang.Integer>	computeRange() Compute the Doc's Range of Input.Tokens.
protected float	computeWidth() Compute the Doc's width.
java.util.OptionalInt	getColumnLimitBeforeLastBreak() An optional, more restrictive column limit for inner breaks that are marked as Break.hasColumnLimit().
java.util.Optional<java.lang.String>	getDebugName()
OpenOp	getOpenOp()
Indent	getPlusIndent()
PartialInlineability	partialInlineability()
java.lang.String	representation(State state) An indented representation of this level and all nested levels inside it.
java.lang.String	toString()
void	write(State state, Output output) Write a Doc to an Output, after breaking decisions have been made.

Methods inherited from class com.palantir.javaformat.doc.Doc

getFlat

Methods inherited from class com.palantir.javaformat.doc.HasUniqueId

id

Methods inherited from class java.lang.Object

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

Method Detail

computeWidth

protected float computeWidth()

Description copied from class: Doc

Compute the Doc's width.

Specified by:

computeWidth in class Doc

Returns:

the width, or Float.POSITIVE_INFINITY if it must be broken

computeFlat

protected java.lang.String computeFlat()

Description copied from class: Doc

Compute the Doc's flat value. Not defined (and never called) if contains forced breaks.

Specified by:

computeFlat in class Doc

Returns:

the flat value

computeRange

protected com.google.common.collect.Range<java.lang.Integer> computeRange()

Description copied from class: Doc

Compute the Doc's Range of Input.Tokens.

Specified by:

computeRange in class Doc

Returns:

the Range

computeBreaks

public State computeBreaks(CommentsHelper commentsHelper,
                           int maxWidth,
                           State state,
                           Obs.ExplorationNode observer)

Description copied from class: Doc

Make breaking decisions for a Doc.

Specified by:

computeBreaks in class Doc

maxWidth - the maximum line width

state - the current output state

Returns:

the new output state

write

public void write(State state,
                  Output output)

Description copied from class: Doc

Write a Doc to an Output, after breaking decisions have been made.

Specified by:

write in class Doc

getPlusIndent

public Indent getPlusIndent()

partialInlineability

public PartialInlineability partialInlineability()

getDebugName

public java.util.Optional<java.lang.String> getDebugName()

getOpenOp

public OpenOp getOpenOp()

getColumnLimitBeforeLastBreak

public java.util.OptionalInt getColumnLimitBeforeLastBreak()

An optional, more restrictive column limit for inner breaks that are marked as Break.hasColumnLimit(). If the level is to be considered one-lineable, the last such break must not start at a column higher than this.

representation

public java.lang.String representation(State state)

An indented representation of this level and all nested levels inside it.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object