Package com.google.googlejavaformat

Class Doc

java.lang.Object

com.google.googlejavaformat.Doc

Direct Known Subclasses:

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

public abstract class Doc
extends Object

JavaInputAstVisitor outputs a sequence of Ops using OpsBuilder. This linear sequence is then transformed by DocBuilder into a tree-structured Doc. The top-level Doc is a Doc.Level, which contains a sequence of Docs, including other Doc.Levels. Leaf Docs are Doc.Tokens, representing language-level tokens; Doc.Toks, which may also represent non-token Input.Toks, including comments and other white-space; Doc.Spaces, representing single spaces; and Doc.Breaks, which represent optional line-breaks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Doc.Break	A leaf node in a Doc for an optional break.
static enum	Doc.FillMode	Each Doc.Break in a Doc.Level is either Doc.FillMode.UNIFIED or Doc.FillMode.INDEPENDENT.
(package private) static final class	Doc.Level	A Level inside a Doc.
(package private) static final class	Doc.Space	A Leaf node in a Doc for a non-breaking space.
static final class	Doc.State	State for writing.
(package private) static final class	Doc.Tok	A leaf node in a Doc for a non-token.
static final class	Doc.Token	A leaf Doc for a token.

Field Summary

Fields

Modifier and Type	Field	Description
private static final com.google.common.collect.Range<Integer>	EMPTY_RANGE
private final com.google.common.base.Supplier<String>	flat
private static final com.google.common.collect.DiscreteDomain<Integer>	INTEGERS
static final int	MAX_LINE_WIDTH	The maximum supported line width.
private final com.google.common.base.Supplier<com.google.common.collect.Range<Integer>>	range
private final com.google.common.base.Supplier<Integer>	width

Constructor Summary

Constructors

Constructor	Description
Doc()

Method Summary

Modifier and Type	Method	Description
abstract Doc.State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, Doc.State state)	Make breaking decisions for a Doc.
(package private) abstract String	computeFlat()	Compute the Doc's flat value.
(package private) abstract com.google.common.collect.Range<Integer>	computeRange()	Compute the Doc's Range of Input.Tokens.
(package private) abstract int	computeWidth()	Compute the Doc's width.
(package private) final String	getFlat()	Return a Doc's flat-string value; not defined (and never called) if the Doc contains forced breaks.
(package private) final int	getWidth()	Return the width of a Doc.
(package private) final com.google.common.collect.Range<Integer>	range()	Return the Range of a Doc.
abstract 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, toString, wait, wait, wait

Field Details

MAX_LINE_WIDTH

public static final int MAX_LINE_WIDTH

The maximum supported line width.

This can be used as a sentinel/threshold for Docs that break unconditionally.

The value was selected to be obviously too large for any practical line, but small enough to prevent accidental overflow.

See Also:

• Constant Field Values

EMPTY_RANGE

private static final com.google.common.collect.Range<Integer> EMPTY_RANGE

INTEGERS

private static final com.google.common.collect.DiscreteDomain<Integer> INTEGERS

width

private final com.google.common.base.Supplier<Integer> width

flat

private final com.google.common.base.Supplier<String> flat

range

private final com.google.common.base.Supplier<com.google.common.collect.Range<Integer>> range

Constructor Details

Doc

public Doc()

Method Details

getWidth

final int getWidth()

Return the width of a Doc.

Returns:

the width

getFlat

final String getFlat()

Return a Doc's flat-string value; not defined (and never called) if the Doc contains forced breaks.

Returns:

the flat-string value

range

final com.google.common.collect.Range<Integer> range()

Return the Range of a Doc.

Returns:

the Doc's Range

computeWidth

abstract int computeWidth()

Compute the Doc's width.

Returns:

the width

computeFlat

abstract String computeFlat()

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

Returns:

the flat value

computeRange

abstract com.google.common.collect.Range<Integer> computeRange()

Compute the Doc's Range of Input.Tokens.

Returns:

the Range

computeBreaks

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

Make breaking decisions for a Doc.

Parameters:

maxWidth - the maximum line width

state - the current output state

Returns:

the new output state

write

public abstract void write(Output output)

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