Module aya.pretty

Package org.aya.pretty.doc

Record Class Styles

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Styles

public record Styles(kala.collection.mutable.MutableList<Style> styles)
extends Record

Constructor Summary

Constructors

Constructor	Description
Styles(kala.collection.mutable.MutableList<Style> styles)	Creates an instance of a Styles record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Styles	bold()
@NotNull Styles	code()
@NotNull Styles	color(float r, float g, float b)
@NotNull Styles	color(int color)
@NotNull Styles	color(@NotNull String colorName)
@NotNull Styles	colorBG(int color)
@NotNull Styles	colorBG(@NotNull String colorName)
@NotNull Styles	custom(Style.CustomStyle style)
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 Styles	italic()
@NotNull Styles	preset(@NotNull String styleName)
@NotNull Styles	strike()
kala.collection.mutable.MutableList<Style>	styles()	Returns the value of the styles record component.
final String	toString()	Returns a string representation of this record class.
@NotNull Styles	underline()

Methods inherited from class java.lang.Object

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

Constructor Details

Styles

public Styles(kala.collection.mutable.MutableList<Style> styles)

Creates an instance of a Styles record class.

Parameters:

styles - the value for the styles record component

Method Details

italic

@NotNull
public @NotNull Styles italic()

bold

@NotNull
public @NotNull Styles bold()

strike

@NotNull
public @NotNull Styles strike()

code

@NotNull
public @NotNull Styles code()

underline

@NotNull
public @NotNull Styles underline()

color

@NotNull
public @NotNull Styles color(@NotNull
 @NotNull String colorName)

colorBG

@NotNull
public @NotNull Styles colorBG(@NotNull
 @NotNull String colorName)

color

@NotNull
public @NotNull Styles color(int color)

color

@NotNull
public @NotNull Styles color(float r,
 float g,
 float b)

colorBG

@NotNull
public @NotNull Styles colorBG(int color)

custom

@NotNull
public @NotNull Styles custom(@NotNull
 Style.CustomStyle style)

preset

@NotNull
public @NotNull Styles preset(@NotNull
 @NotNull String styleName)

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.

styles

public kala.collection.mutable.MutableList<Style> styles()

Returns the value of the styles record component.

Returns:

the value of the styles record component