Module aya.cli.impl

Package org.aya.cli.literate

Record Class FlclFaithfulPrettier

java.lang.Object

java.lang.Record

org.aya.cli.literate.FlclFaithfulPrettier

All Implemented Interfaces:

FaithfulPrettier

public record FlclFaithfulPrettier(@NotNull org.aya.util.prettier.PrettierOptions options)
extends Record
implements FaithfulPrettier

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.cli.literate.FaithfulPrettier

FaithfulPrettier.KnifeCut

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull org.aya.pretty.doc.Link	EMPTY_LINK

Constructor Summary

Constructors

Constructor	Description
FlclFaithfulPrettier(@NotNull org.aya.util.prettier.PrettierOptions options)	Creates an instance of a FlclFaithfulPrettier 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 org.aya.pretty.doc.Doc	highlight(org.aya.producer.flcl.FlclToken.File file)
@NotNull org.aya.util.prettier.PrettierOptions	options()	Returns the value of the options record component.
static @NotNull HighlightInfo	toInfo(org.aya.producer.flcl.FlclToken flclToken)
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.cli.literate.FaithfulPrettier

doHighlight

Field Details

EMPTY_LINK

@NotNull
public static final @NotNull org.aya.pretty.doc.Link EMPTY_LINK

Constructor Details

FlclFaithfulPrettier

public FlclFaithfulPrettier(@NotNull
 @NotNull org.aya.util.prettier.PrettierOptions options)

Creates an instance of a FlclFaithfulPrettier record class.

Parameters:

options - the value for the options record component

Method Details

toInfo

@NotNull
public static @NotNull HighlightInfo toInfo(org.aya.producer.flcl.FlclToken flclToken)

highlight

@NotNull
public @NotNull org.aya.pretty.doc.Doc highlight(@NotNull
 org.aya.producer.flcl.FlclToken.File file)

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.

options

@NotNull
public @NotNull org.aya.util.prettier.PrettierOptions options()

Returns the value of the options record component.

Specified by:

options in interface FaithfulPrettier

Returns:

the value of the options record component