Record Class ScriptConfig

java.lang.Object

java.lang.Record

com.botwithus.bot.api.config.ScriptConfig

Record Components:

values - raw key/value map; defensively copied by the compact constructor

public record ScriptConfig(Map<String,String> values)
extends Record

Immutable snapshot of a script's configuration values. Passed to BotScript.onConfigUpdate(ScriptConfig).

Constructor Summary

Constructors

Constructor	Description
ScriptConfig(Map<String,String> values)	Creates an instance of a ScriptConfig record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	asMap()	Returns an unmodifiable view of the raw values.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	getBoolean(String key, boolean defaultValue)
int	getInt(String key, int defaultValue)	Falls back to default if absent or unparseable.
String	getString(String key, String defaultValue)
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
Map<String,String>	values()	Returns the value of the values record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScriptConfig

public ScriptConfig(Map<String,String> values)

Creates an instance of a ScriptConfig record class.

Parameters:

values - the value for the values record component

Method Details

getInt

public int getInt(String key,
 int defaultValue)

Falls back to default if absent or unparseable.

getString

public String getString(String key,
 String defaultValue)

getBoolean

public boolean getBoolean(String key,
 boolean defaultValue)

asMap

public Map<String,String> asMap()

Returns an unmodifiable view of the raw values.

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.

values

public Map<String,String> values()

Returns the value of the values record component.

Returns:

the value of the values record component