Record Class ConsoleManager.Message

java.lang.Object

java.lang.Record

gaiasky.script.ConsoleManager.Message

Record Components:

msg - The message string.

type - The message type.

time - The message creation time.

Enclosing class:

ConsoleManager

public static record ConsoleManager.Message(String msg, ConsoleManager.MsgType type, Instant time)
extends Record

A single console message. Typically, this is represented visually by a single line.

Constructor Summary

Constructors

Constructor	Description
Message(String msg, ConsoleManager.MsgType type, Instant time)	Creates an instance of a Message record class.

Method Summary

Modifier and Type	Method	Description
String	cleanMessage()	Returns the message with any ANSI codes stripped.
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	msg()	Returns the value of the msg record component.
Instant	time()	Returns the value of the time record component.
final String	toString()	Returns a string representation of this record class.
ConsoleManager.MsgType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

Message

public Message(String msg,
 ConsoleManager.MsgType type,
 Instant time)

Creates an instance of a Message record class.

Parameters:

msg - the value for the msg record component

type - the value for the type record component

time - the value for the time record component

Method Details

cleanMessage

public String cleanMessage()

Returns the message with any ANSI codes stripped.

Returns:

The message with no ANIS codes.

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.

msg

public String msg()

Returns the value of the msg record component.

Returns:

the value of the msg record component

type

public ConsoleManager.MsgType type()

Returns the value of the type record component.

Returns:

the value of the type record component

time

public Instant time()

Returns the value of the time record component.

Returns:

the value of the time record component