Package com.google.googlejavaformat

Class Doc.Break

java.lang.Object

com.google.googlejavaformat.Doc

com.google.googlejavaformat.Doc.Break

All Implemented Interfaces:

Op

Enclosing class:

Doc

public static final class Doc.Break
extends Doc
implements Op

A leaf node in a Doc for an optional break.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.googlejavaformat.Doc

Doc.Break, Doc.FillMode, Doc.Level, Doc.Space, Doc.State, Doc.Tok, Doc.Token

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	broken	Was this break taken?
private final Doc.FillMode	fillMode
private final String	flat
(package private) int	newIndent	New indent after this break.
private final Optional<Output.BreakTag>	optTag
private final Indent	plusIndent

Fields inherited from class com.google.googlejavaformat.Doc

MAX_LINE_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Break(Doc.FillMode fillMode, String flat, Indent plusIndent, Optional<Output.BreakTag> optTag)

Method Summary

Modifier and Type	Method	Description
void	add(DocBuilder builder)	Add an Op to a DocBuilder.
Doc.State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, Doc.State state)	Make breaking decisions for a Doc.
Doc.State	computeBreaks(Doc.State state, int lastIndent, boolean broken)
(package private) String	computeFlat()	Compute the Doc's flat value.
(package private) com.google.common.collect.Range<Integer>	computeRange()	Compute the Doc's Range of Input.Tokens.
(package private) int	computeWidth()	Compute the Doc's width.
(package private) int	getPlusIndent()	Return the Break's extra indent.
(package private) boolean	isForced()	Is the Break forced?
static Doc.Break	make(Doc.FillMode fillMode, String flat, Indent plusIndent)	Make a Break.
static Doc.Break	make(Doc.FillMode fillMode, String flat, Indent plusIndent, Optional<Output.BreakTag> optTag)	Make a Break.
static Doc.Break	makeForced()	Make a forced Break.
String	toString()
void	write(Output output)	Write a Doc to an Output, after breaking decisions have been made.

Methods inherited from class com.google.googlejavaformat.Doc

getFlat, getWidth, range

Methods inherited from class java.lang.Object

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

Field Details

fillMode

private final Doc.FillMode fillMode

flat

private final String flat

plusIndent

private final Indent plusIndent

optTag

private final Optional<Output.BreakTag> optTag

broken

boolean broken

Was this break taken?

newIndent

int newIndent

New indent after this break.

Constructor Details

Break

private Break(Doc.FillMode fillMode,
 String flat,
 Indent plusIndent,
 Optional<Output.BreakTag> optTag)

Method Details

make

public static Doc.Break make(Doc.FillMode fillMode,
 String flat,
 Indent plusIndent)

Make a Break.

Parameters:

fillMode - the Doc.FillMode

flat - the text when not broken

plusIndent - extra indent if taken

Returns:

the new Break

make

public static Doc.Break make(Doc.FillMode fillMode,
 String flat,
 Indent plusIndent,
 Optional<Output.BreakTag> optTag)

Make a Break.

Parameters:

fillMode - the Doc.FillMode

flat - the text when not broken

plusIndent - extra indent if taken

optTag - an optional tag for remembering whether the break was taken

Returns:

the new Break

makeForced

public static Doc.Break makeForced()

Make a forced Break.

Returns:

the new forced Break

getPlusIndent

int getPlusIndent()

Return the Break's extra indent.

Returns:

the extra indent

isForced

boolean isForced()

Is the Break forced?

Returns:

whether the Break is forced

add

public void add(DocBuilder builder)

Description copied from interface: Op

Add an Op to a DocBuilder.

Specified by:

add in interface Op

Parameters:

builder - the DocBuilder

computeWidth

int computeWidth()

Description copied from class: Doc

Compute the Doc's width.

Specified by:

computeWidth in class Doc

Returns:

the width

computeFlat

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

com.google.common.collect.Range<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 Doc.State computeBreaks(Doc.State state,
 int lastIndent,
 boolean broken)

computeBreaks

public Doc.State computeBreaks(CommentsHelper commentsHelper,
 int maxWidth,
 Doc.State state)

Description copied from class: Doc

Make breaking decisions for a Doc.

Specified by:

computeBreaks in class Doc

Parameters:

maxWidth - the maximum line width

state - the current output state

Returns:

the new output state

write

public void write(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

toString

public String toString()

Overrides:

toString in class Object