程序包 com.palantir.javaformat.doc

类 Comment

java.lang.Object

com.palantir.javaformat.doc.HasUniqueId

com.palantir.javaformat.doc.Doc

com.palantir.javaformat.doc.Comment

所有已实现的接口:

Op

@Immutable
public final class Comment
extends Doc
implements Op

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

方法概要

修饰符和类型	方法	说明
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.

从类继承的方法 com.palantir.javaformat.doc.Doc

getFlat

从类继承的方法 com.palantir.javaformat.doc.HasUniqueId

id

从类继承的方法 java.lang.Object

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

方法详细资料

make

public static Comment make(Input.Tok tok)

Factory method for a Tok.

参数:

tok - the Input.Tok to wrap

返回:

the new Tok

add

public void add(DocBuilder builder)

从接口复制的说明: Op

Add an Op to a DocBuilder.

指定者:

add 在接口中 Op

参数:

builder - the DocBuilder

computeWidth

protected float computeWidth()

从类复制的说明: Doc

Compute the Doc's width.

指定者:

computeWidth 在类中 Doc

返回:

the width, or Float.POSITIVE_INFINITY if it must be broken

computeFlat

protected String computeFlat()

从类复制的说明: Doc

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

指定者:

computeFlat 在类中 Doc

返回:

the flat value

computeRange

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

从类复制的说明: Doc

Compute the Doc's Range of Input.Tokens.

指定者:

computeRange 在类中 Doc

返回:

the Range

computeBreaks

public State computeBreaks(CommentsHelper commentsHelper,
 int maxWidth,
 State state,
 Obs.ExplorationNode observationNode)

从类复制的说明: Doc

Make breaking decisions for a Doc.

指定者:

computeBreaks 在类中 Doc

参数:

maxWidth - the maximum line width

state - the current output state

返回:

the new output state

write

public void write(State state,
 Output output)

从类复制的说明: Doc

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

指定者:

write 在类中 Doc

toString

public String toString()

覆盖:

toString 在类中 Object