Record Class Doc.Nest

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Doc.Nest

All Implemented Interfaces:

Doc, Docile

Enclosing interface:

Doc

public static record Doc.Nest(int indent, @NotNull Doc doc)
extends Record
implements Doc

Document indented by a number of columns

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.InlineMath, Doc.Line, Doc.List, Doc.MathBlock, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Tooltip, Doc.Union

Field Summary

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

ALT_WS, COMMA, ONE_WS

Constructor Summary

Constructors

Constructor	Description
Nest(int indent, @NotNull Doc doc)	Creates an instance of a Nest record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Doc	doc()	Returns the value of the doc 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.
int	indent()	Returns the value of the indent 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

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

Constructor Details

Nest

public Nest(int indent,
 @NotNull
 @NotNull Doc doc)

Creates an instance of a Nest record class.

Parameters:

indent - the value for the indent record component

doc - the value for the doc 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

indent

public int indent()

Returns the value of the indent record component.

Returns:

the value of the indent record component

doc

@NotNull
public @NotNull Doc doc()

Returns the value of the doc record component.

Returns:

the value of the doc record component