模块 org.aya.pretty

程序包 org.aya.pretty.doc

Record Class Doc.FlatAlt

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Doc.FlatAlt

所有已实现的接口:

Doc, Docile

封闭接口:

Doc

public static record Doc.FlatAlt(@NotNull Doc defaultDoc, @NotNull Doc preferWhenFlatten)
extends Record
implements Doc

Lay out the defaultDoc 'Doc', but when flattened (via 'group'), prefer the preferWhenFlatten. The layout algorithms work under the assumption that the defaultDoc alternative is less wide than the flattened preferWhenFlatten alternative.

嵌套类概要

从接口继承的嵌套类/接口 org.aya.pretty.doc.Doc

Doc.Cat, Doc.Column, Doc.Empty, Doc.FlatAlt, Doc.HyperLinked, Doc.Line, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Union

字段概要

从接口继承的字段 org.aya.pretty.doc.Doc

ALT_WS, ONE_WS

构造器概要

构造器

构造器	说明
FlatAlt(@NotNull Doc defaultDoc, @NotNull Doc preferWhenFlatten)	创建 FlatAlt 记录的实例。

方法概要

修饰符和类型	方法	说明
@NotNull Doc	defaultDoc()	返回 defaultDoc 记录组件的值。
final boolean	equals(Object o)	指示某个其他对象是否“等于”此对象。
final int	hashCode()	返回此对象的哈希代码值。
@NotNull Doc	preferWhenFlatten()	返回 preferWhenFlatten 记录组件的值。
final String	toString()	返回此记录的字符串表示形式。

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.aya.pretty.doc.Doc

asSeq, commonRender, debugRender, render, renderToHtml, renderToHtml, renderToString, renderToTeX, renderWithPageWidth, toDoc

构造器详细资料

FlatAlt

public FlatAlt(@NotNull
 @NotNull Doc defaultDoc,
 @NotNull
 @NotNull Doc preferWhenFlatten)

创建 FlatAlt 记录的实例。

参数:

defaultDoc - defaultDoc 记录组件的值

preferWhenFlatten - preferWhenFlatten 记录组件的值

方法详细资料

toString

public final String toString()

返回此记录的字符串表示形式。此表示形式包含类型的名称，后跟每个记录组件的名称和值。

指定者:

toString 在类中 Record

返回:

此对象的字符串表示形式

hashCode

public final int hashCode()

返回此对象的哈希代码值。此值派生自每个记录组件的哈希代码。

指定者:

hashCode 在类中 Record

返回:

此对象的哈希代码值

equals

public final boolean equals(Object o)

指示某个其他对象是否“等于”此对象。如果两个对象属于同一个类，而且所有记录组件都相等，则这两个对象相等。 此记录中的所有组件都使用 Objects::equals(Object,Object) 进行比较。

指定者:

equals 在类中 Record

参数:

o - 要与之进行比较的对象

返回:

如果此对象与 o 参数相同，则为 true；否则为 false。

defaultDoc

@NotNull
public @NotNull Doc defaultDoc()

返回 defaultDoc 记录组件的值。

返回:

defaultDoc 记录组件的值

preferWhenFlatten

@NotNull
public @NotNull Doc preferWhenFlatten()

返回 preferWhenFlatten 记录组件的值。

返回:

preferWhenFlatten 记录组件的值