Module com.google.googlejavaformat

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.State, Doc.Token

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)
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 java.lang.Object

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

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

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

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

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