Module aya.pretty

Package org.aya.pretty.doc

Record Class Doc.Union

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Doc.Union

All Implemented Interfaces:

Doc, Docile

Enclosing interface:

Doc

public static record Doc.Union(@NotNull Doc shorterOne, @NotNull Doc longerOne)
extends Record
implements Doc

The first lines of first document should be shorter than the first lines of the second one, so the layout algorithm can pick the one that fits best. Used to implement layout alternatives for 'softline' and 'group'.

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
Union(@NotNull Doc shorterOne, @NotNull Doc longerOne)	Creates an instance of a Union record class.

Method Summary

Modifier and Type	Method	Description
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	longerOne()	Returns the value of the longerOne record component.
@NotNull Doc	shorterOne()	Returns the value of the shorterOne 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

Union

public Union(@NotNull
 @NotNull Doc shorterOne,
 @NotNull
 @NotNull Doc longerOne)

Creates an instance of a Union record class.

Parameters:

shorterOne - the value for the shorterOne record component

longerOne - the value for the longerOne 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.

shorterOne

@NotNull
public @NotNull Doc shorterOne()

Returns the value of the shorterOne record component.

Returns:

the value of the shorterOne record component

longerOne

@NotNull
public @NotNull Doc longerOne()

Returns the value of the longerOne record component.

Returns:

the value of the longerOne record component