Module aya.pretty

Package org.aya.pretty.doc

Record Class Style.LineThrough

java.lang.Object

java.lang.Record

org.aya.pretty.doc.Style.LineThrough

All Implemented Interfaces:

Serializable, Style

Enclosing interface:

Style

public static record Style.LineThrough(@NotNull Style.LineThrough.Position position, @NotNull Style.LineThrough.Shape shape, @Nullable Style.Color color)
extends Record
implements Style

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Style.LineThrough.Position
static enum	Style.LineThrough.Shape

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

Style.Attr, Style.Color, Style.ColorHex, Style.ColorName, Style.CustomStyle, Style.LineThrough, Style.Preset

Constructor Summary

Constructors

Constructor	Description
LineThrough(@NotNull Style.LineThrough.Position position, @NotNull Style.LineThrough.Shape shape, @Nullable Style.Color color)	Creates an instance of a LineThrough record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Style.Color	color()	Returns the value of the color 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 Style.LineThrough.Position	position()	Returns the value of the position record component.
@NotNull Style.LineThrough.Shape	shape()	Returns the value of the shape 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.Style

and

Constructor Details

LineThrough

public LineThrough(@NotNull
 @NotNull Style.LineThrough.Position position,
 @NotNull
 @NotNull Style.LineThrough.Shape shape,
 @Nullable
 @Nullable Style.Color color)

Creates an instance of a LineThrough record class.

Parameters:

position - the value for the position record component

shape - the value for the shape record component

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

position

@NotNull
public @NotNull Style.LineThrough.Position position()

Returns the value of the position record component.

Returns:

the value of the position record component

shape

@NotNull
public @NotNull Style.LineThrough.Shape shape()

Returns the value of the shape record component.

Returns:

the value of the shape record component

color

@Nullable
public @Nullable Style.Color color()

Returns the value of the color record component.

Returns:

the value of the color record component