Package com.blamejared.crafttweaker.api.zencode.scriptrun

Record Class ScriptDiscoveryConfiguration

java.lang.Object

java.lang.Record

com.blamejared.crafttweaker.api.zencode.scriptrun.ScriptDiscoveryConfiguration

Record Components:

suspiciousNamesBehavior - The behavior to use whenever a file with a suspicious name is encountered during discovery.

retainer - The ScriptDiscoveryConfiguration.DiscoveryRetainer to invoke to store the list of discovered files.

public record ScriptDiscoveryConfiguration(ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior, ScriptDiscoveryConfiguration.DiscoveryRetainer retainer)
extends Record

Holds the configuration that should be followed during automatic script discovery for the creation of a IScriptRun.

Since:

10.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScriptDiscoveryConfiguration.DiscoveryRetainer	Represents a callback that can be used to retain the results of the discovery process.
static enum	ScriptDiscoveryConfiguration.SuspiciousNamesBehavior	Specifies the behavior to be used when a file with a suspicious name is encountered.

Constructor Summary

Constructors

Constructor	Description
ScriptDiscoveryConfiguration(ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior)	Creates a ScriptDiscoveryConfiguration with the given behavior and a no-op ScriptDiscoveryConfiguration.DiscoveryRetainer.
ScriptDiscoveryConfiguration(ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior, ScriptDiscoveryConfiguration.DiscoveryRetainer retainer)	Creates an instance of a ScriptDiscoveryConfiguration record class.

Method Summary

Modifier and Type	Method	Description
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.
ScriptDiscoveryConfiguration.DiscoveryRetainer	retainer()	Returns the value of the retainer record component.
ScriptDiscoveryConfiguration.SuspiciousNamesBehavior	suspiciousNamesBehavior()	Returns the value of the suspiciousNamesBehavior record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptDiscoveryConfiguration

public ScriptDiscoveryConfiguration(ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior)

Creates a ScriptDiscoveryConfiguration with the given behavior and a no-op ScriptDiscoveryConfiguration.DiscoveryRetainer.

Parameters:

suspiciousNamesBehavior - The behavior to use whenever a file with a suspicious name is encountered during discovery.

Since:

10.1.0

ScriptDiscoveryConfiguration

public ScriptDiscoveryConfiguration(ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior,
 ScriptDiscoveryConfiguration.DiscoveryRetainer retainer)

Creates an instance of a ScriptDiscoveryConfiguration record class.

Parameters:

suspiciousNamesBehavior - the value for the suspiciousNamesBehavior record component

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

suspiciousNamesBehavior

public ScriptDiscoveryConfiguration.SuspiciousNamesBehavior suspiciousNamesBehavior()

Returns the value of the suspiciousNamesBehavior record component.

Returns:

the value of the suspiciousNamesBehavior record component

retainer

public ScriptDiscoveryConfiguration.DiscoveryRetainer retainer()

Returns the value of the retainer record component.

Returns:

the value of the retainer record component