Record Class ScriptInfo

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.ScriptInfo

Record Components:

name - display name from ScriptManifest

version - version string, or "?" if unknown

author - author, or "unknown" if not declared

description - description, or empty string

category - script category, or ScriptCategory.UNCATEGORIZED

running - whether the script is currently executing

className - fully qualified class name of the script implementation

public record ScriptInfo(String name, String version, String author, String description, ScriptCategory category, boolean running, String className)
extends Record

Read-only snapshot of a script's metadata and current state.

Constructor Summary

Constructors

Constructor	Description
ScriptInfo(String name, String version, String author, String description, ScriptCategory category, boolean running, String className)	Creates an instance of a ScriptInfo record class.

Method Summary

Modifier and Type	Method	Description
String	author()	Returns the value of the author record component.
ScriptCategory	category()	Returns the value of the category record component.
String	className()	Returns the value of the className record component.
String	description()	Returns the value of the description 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	name()	Returns the value of the name record component.
boolean	running()	Returns the value of the running record component.
final String	toString()	Returns a string representation of this record class.
String	version()	Returns the value of the version record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScriptInfo

public ScriptInfo(String name,
 String version,
 String author,
 String description,
 ScriptCategory category,
 boolean running,
 String className)

Creates an instance of a ScriptInfo record class.

Parameters:

name - the value for the name record component

version - the value for the version record component

author - the value for the author record component

description - the value for the description record component

category - the value for the category record component

running - the value for the running record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

author

public String author()

Returns the value of the author record component.

Returns:

the value of the author record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

category

public ScriptCategory category()

Returns the value of the category record component.

Returns:

the value of the category record component

running

public boolean running()

Returns the value of the running record component.

Returns:

the value of the running record component

className

public String className()

Returns the value of the className record component.

Returns:

the value of the className record component