Record Class DrawCaption.FixedPoint

java.lang.Object

java.lang.Record

com.botwithus.bot.api.draw.DrawCaption.FixedPoint

Record Components:

value - the scaled integer

decimals - how far it was scaled, 0..DrawLimits.MAX_DECIMALS

font - the style to draw it in

All Implemented Interfaces:

DrawCaption

Enclosing interface:

DrawCaption

public static record DrawCaption.FixedPoint(long value, int decimals, DrawFont font)
extends Record
implements DrawCaption

A fixed-point number the producer formats.

Nested Class Summary

Nested classes/interfaces inherited from interface DrawCaption

DrawCaption.FixedPoint, DrawCaption.Literal, DrawCaption.None

Field Summary

Fields inherited from interface DrawCaption

NONE

Constructor Summary

Constructors

Constructor	Description
FixedPoint(long value, int decimals, DrawFont font)	Creates an instance of a FixedPoint record class.

Method Summary

Modifier and Type	Method	Description
int	decimals()	Returns the value of the decimals record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
DrawFont	font()	Returns the value of the font record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
long	value()	Returns the value of the value record component.
DrawCaption	withFont(DrawFont other)	This caption in a different style.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DrawCaption

isEmpty

Constructor Details

FixedPoint

public FixedPoint(long value,
 int decimals,
 DrawFont font)

Creates an instance of a FixedPoint record class.

Parameters:

value - the value for the value record component

decimals - the value for the decimals record component

font - the value for the font record component

Method Details

withFont

public DrawCaption withFont(DrawFont other)

Description copied from interface: DrawCaption

This caption in a different style.

Specified by:

withFont in interface DrawCaption

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.

value

public long value()

Returns the value of the value record component.

Returns:

the value of the value record component

decimals

public int decimals()

Returns the value of the decimals record component.

Returns:

the value of the decimals record component

font

public DrawFont font()

Returns the value of the font record component.

Returns:

the value of the font record component