Package com.palantir.javaformat.doc

Class Comment

java.lang.Object

com.palantir.javaformat.doc.HasUniqueId

com.palantir.javaformat.doc.Doc

com.palantir.javaformat.doc.Comment

All Implemented Interfaces:

Op

@Immutable
public final class Comment
extends Doc
implements Op

A leaf node in a Doc for a non-token.

Method Summary

Modifier and Type	Method	Description
void	add(DocBuilder builder)	Add an Op to a DocBuilder.
State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observationNode)	Make breaking decisions for a Doc.
protected String	computeFlat()	Compute the Doc's flat value.
protected com.google.common.collect.Range<Integer>	computeRange()	Compute the Doc's Range of Input.Tokens.
protected float	computeWidth()	Compute the Doc's width.
static Comment	make(Input.Tok tok)	Factory method for a Tok.
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 Details

make

public static Comment make(Input.Tok tok)

Factory method for a Tok.

Parameters:

tok - the Input.Tok to wrap

Returns:

the new Tok

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

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 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<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 observationNode)

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

toString

public String toString()

Overrides:

toString in class Object