Record Class DrawCommand.Text

java.lang.Object

java.lang.Record

com.botwithus.bot.api.draw.DrawCommand.Text

All Implemented Interfaces:

DrawCommand, DrawCommand.Primitive

Enclosing interface:

DrawCommand

public static record DrawCommand.Text(String key, DrawSpace space, DrawStyle style, int x, int y, DrawCaption caption)
extends Record
implements DrawCommand.Primitive

A caption anchored at (x, y).

The caption is required here — a text command that draws nothing is not a thing worth sending. It may be literal text or a fixed-point number; see DrawCaption.

Nested Class Summary

Nested classes/interfaces inherited from interface DrawCommand

DrawCommand.Area, DrawCommand.ComponentTarget, DrawCommand.Ellipse, DrawCommand.Entity, DrawCommand.Highlight, DrawCommand.Line, DrawCommand.Poly, DrawCommand.Primitive, DrawCommand.Rect, DrawCommand.Text, DrawCommand.Tile

Constructor Summary

Constructors

Constructor	Description
Text(String key, DrawSpace space, DrawStyle style, int x, int y, DrawCaption caption)	Creates an instance of a Text record class.

Method Summary

Modifier and Type	Method	Description
DrawCaption	caption()	Returns the value of the caption 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.
String	key()	Returns the value of the key record component.
DrawKind	kind()	The primitive this command draws.
DrawSpace	space()	Returns the value of the space record component.
DrawStyle	style()	Returns the value of the style record component.
final String	toString()	Returns a string representation of this record class.
int	x()	Returns the value of the x record component.
int	y()	Returns the value of the y record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Text

public Text(String key,
 DrawSpace space,
 DrawStyle style,
 int x,
 int y,
 DrawCaption caption)

Creates an instance of a Text record class.

Parameters:

key - the value for the key record component

space - the value for the space record component

style - the value for the style record component

x - the value for the x record component

y - the value for the y record component

caption - the value for the caption record component

Method Details

kind

public DrawKind kind()

Description copied from interface: DrawCommand

The primitive this command draws.

Specified by:

kind in interface DrawCommand

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.

key

public String key()

Returns the value of the key record component.

Specified by:

key in interface DrawCommand

Returns:

the value of the key record component

space

public DrawSpace space()

Returns the value of the space record component.

Specified by:

space in interface DrawCommand

Returns:

the value of the space record component

style

public DrawStyle style()

Returns the value of the style record component.

Specified by:

style in interface DrawCommand

Returns:

the value of the style record component

x

public int x()

Returns the value of the x record component.

Returns:

the value of the x record component

y

public int y()

Returns the value of the y record component.

Returns:

the value of the y record component

caption

public DrawCaption caption()

Returns the value of the caption record component.

Returns:

the value of the caption record component