Module aya.pretty

Package org.aya.pretty.doc

Record Class Doc.FlatAlt

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Doc.FlatAlt

All Implemented Interfaces:

Doc, Docile

Enclosing interface:

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.pretty.doc.Doc

Doc.Cat, Doc.CodeBlock, Doc.Column, Doc.Empty, Doc.EscapedText, Doc.FlatAlt, Doc.HyperLinked, Doc.Image, Doc.InlineCode, Doc.Line, Doc.List, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Union

Field Summary

Fields inherited from interface org.aya.pretty.doc.Doc

ALT_WS, COMMA, ONE_WS

Constructor Summary

Constructors

Constructor	Description
FlatAlt(@NotNull Doc defaultDoc, @NotNull Doc preferWhenFlatten)	Creates an instance of a FlatAlt record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Doc	defaultDoc()	Returns the value of the defaultDoc record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull Doc	preferWhenFlatten()	Returns the value of the preferWhenFlatten record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aya.pretty.doc.Doc

asSeq, commonRender, debugRender, isEmpty, isNotEmpty, render, renderToAyaMd, renderToHtml, renderToHtml, renderToMd, renderToString, renderToString, renderToTerminal, renderToTerminal, renderToTeX, toDoc

Constructor Details

FlatAlt

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

Creates an instance of a FlatAlt record class.

Parameters:

defaultDoc - the value for the defaultDoc record component

preferWhenFlatten - the value for the preferWhenFlatten record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

defaultDoc

@NotNull
public @NotNull Doc defaultDoc()

Returns the value of the defaultDoc record component.

Returns:

the value of the defaultDoc record component

preferWhenFlatten

@NotNull
public @NotNull Doc preferWhenFlatten()

Returns the value of the preferWhenFlatten record component.

Returns:

the value of the preferWhenFlatten record component