程序包 com.palantir.javaformat.doc

类 Break

java.lang.Object

com.palantir.javaformat.doc.HasUniqueId

com.palantir.javaformat.doc.Doc

com.palantir.javaformat.doc.Break

所有已实现的接口:

Op

@Immutable
@Immutable
public abstract class Break
extends Doc
implements Op

A leaf node in a Doc for an optional break.

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	Break.Builder

构造器概要

构造器

构造器	说明
Break()

方法概要

修饰符和类型	方法	说明
void	add(DocBuilder builder)	Add an Op to a DocBuilder.
static Break.Builder	builder()
State	computeBreaks(CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observationNode)	Make breaking decisions for a Doc.
State	computeBreaks(State stateIn, boolean broken)
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.
int	evalPlusIndent(State state)	Return the Break's extra indent.
abstract FillMode	fillMode()
abstract String	flat()
abstract boolean	hasColumnLimit()	If this break is restricted by its parent Level's Level.getColumnLimitBeforeLastBreak().
boolean	isForced()	Is the Break forced?
static Break	make(FillMode fillMode, String flat, Indent plusIndent)	Make a Break.
static Break	make(FillMode fillMode, String flat, Indent plusIndent, Optional<BreakTag> optTag)	Make a Break.
static Break	makeForced()	Make a forced Break.
abstract Optional<BreakTag>	optTag()
abstract Indent	plusIndent()
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, toString, wait, wait, wait

构造器详细资料

Break

public Break()

方法详细资料

fillMode

public abstract FillMode fillMode()

flat

public abstract String flat()

plusIndent

public abstract Indent plusIndent()

optTag

public abstract Optional<BreakTag> optTag()

hasColumnLimit

public abstract boolean hasColumnLimit()

If this break is restricted by its parent Level's Level.getColumnLimitBeforeLastBreak().

make

public static Break make(FillMode fillMode,
 String flat,
 Indent plusIndent)

Make a Break.

参数:

fillMode - the FillMode

flat - the text when not broken

plusIndent - extra indent if taken

返回:

the new Break

make

public static Break make(FillMode fillMode,
 String flat,
 Indent plusIndent,
 Optional<BreakTag> optTag)

Make a Break.

参数:

fillMode - the FillMode

flat - the text when not broken

plusIndent - extra indent if taken

optTag - an optional tag for remembering whether the break was taken

返回:

the new Break

makeForced

public static Break makeForced()

Make a forced Break.

返回:

the new forced Break

evalPlusIndent

public int evalPlusIndent(State state)

Return the Break's extra indent.

返回:

the extra indent

isForced

public boolean isForced()

Is the Break forced?

返回:

whether the Break is forced

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(State stateIn,
 boolean broken)

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

builder

public static Break.Builder builder()