Package com.google.googlejavaformat

Class Doc.Token

java.lang.Object

com.google.googlejavaformat.Doc

com.google.googlejavaformat.Doc.Token

All Implemented Interfaces:

Op

Enclosing class:

Doc

public static final class Doc.Token
extends Doc
implements Op

A leaf Doc for a token.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Doc.Token.RealOrImaginary	Is a Token a real token, or imaginary (e.g., a token generated incorrectly, or an EOF)?

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
private java.util.Optional<Indent>	breakAndIndentTrailingComment
private Indent	plusIndentCommentsBefore
private Doc.Token.RealOrImaginary	realOrImaginary
private Input.Token	token

Fields inherited from class com.google.googlejavaformat.Doc

MAX_LINE_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Token(Input.Token token, Doc.Token.RealOrImaginary realOrImaginary, Indent plusIndentCommentsBefore, java.util.Optional<Indent> breakAndIndentTrailingComment)

Method Summary

Modifier and Type	Method	Description
void	add(DocBuilder builder)	Add an Op to a DocBuilder.
(package private) java.util.Optional<Indent>	breakAndIndentTrailingComment()	Force a line break and indent trailing javadoc or block comments.
Doc.State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, Doc.State state)	Make breaking decisions for a Doc.
(package private) java.lang.String	computeFlat()	Compute the Doc's flat value.
(package private) com.google.common.collect.Range<java.lang.Integer>	computeRange()	Compute the Doc's Range of Input.Tokens.
(package private) int	computeWidth()	Compute the Doc's width.
(package private) Indent	getPlusIndentCommentsBefore()	How much extra to indent comments before the Token.
(package private) Input.Token	getToken()	Return the wrapped Input.Token.
(package private) static Op	make(Input.Token token, Doc.Token.RealOrImaginary realOrImaginary, Indent plusIndentCommentsBefore, java.util.Optional<Indent> breakAndIndentTrailingComment)	Make a Token.
(package private) Doc.Token.RealOrImaginary	realOrImaginary()	Is the token good? That is, does it match an Input.Token?
private Input.Tok	tok()
java.lang.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 Detail

token

private final Input.Token token

realOrImaginary

private final Doc.Token.RealOrImaginary realOrImaginary

plusIndentCommentsBefore

private final Indent plusIndentCommentsBefore

breakAndIndentTrailingComment

private final java.util.Optional<Indent> breakAndIndentTrailingComment

Constructor Detail

Token

private Token(Input.Token token,
              Doc.Token.RealOrImaginary realOrImaginary,
              Indent plusIndentCommentsBefore,
              java.util.Optional<Indent> breakAndIndentTrailingComment)

Method Detail

tok

private Input.Tok tok()

getPlusIndentCommentsBefore

Indent getPlusIndentCommentsBefore()

How much extra to indent comments before the Token.

Returns:

the extra indent

breakAndIndentTrailingComment

java.util.Optional<Indent> breakAndIndentTrailingComment()

Force a line break and indent trailing javadoc or block comments.

make

static Op make(Input.Token token,
               Doc.Token.RealOrImaginary realOrImaginary,
               Indent plusIndentCommentsBefore,
               java.util.Optional<Indent> breakAndIndentTrailingComment)

Make a Token.

Parameters:

token - the Input.Token to wrap

realOrImaginary - did this Input.Token appear in the input, or was it generated incorrectly?

plusIndentCommentsBefore - extra plusIndent for comments just before this token

Returns:

the new Token

getToken

Input.Token getToken()

Return the wrapped Input.Token.

Returns:

the Input.Token

realOrImaginary

Doc.Token.RealOrImaginary realOrImaginary()

Is the token good? That is, does it match an Input.Token?

Returns:

whether the @code Token} is good

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

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

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 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 java.lang.String toString()

Overrides:

toString in class java.lang.Object