Package net.mcreator.ui.help

Record Class ModElementHelpContext

java.lang.Object

java.lang.Record

net.mcreator.ui.help.ModElementHelpContext

All Implemented Interfaces:

IHelpContext

public record ModElementHelpContext(@Nullable String contextName, @Nullable URI contextURL, @Nullable String entry, Supplier<GeneratableElement> generatableElement)
extends Record
implements IHelpContext

Field Summary

Fields inherited from interface net.mcreator.ui.help.IHelpContext

NONE

Constructor Summary

Constructors

Constructor	Description
ModElementHelpContext(String contextName, URI contextURL, String entry, Supplier<GeneratableElement> generatableElement)	Creates an instance of a ModElementHelpContext record class.

Method Summary

Modifier and Type	Method	Description
String	contextName()	Returns the value of the contextName record component.
URI	contextURL()	Returns the value of the contextURL record component.
String	entry()	Returns the value of the entry record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Supplier<GeneratableElement>	generatableElement()	Returns the value of the generatableElement record component.
GeneratableElement	getModElementFromGUI()
final int	hashCode()	Returns a hash code value for this object.
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

Methods inherited from interface net.mcreator.ui.help.IHelpContext

withEntry

Constructor Details

ModElementHelpContext

public ModElementHelpContext(@Nullable
 String contextName,
 @Nullable
 URI contextURL,
 @Nullable
 String entry,
 Supplier<GeneratableElement> generatableElement)

Creates an instance of a ModElementHelpContext record class.

Parameters:

contextName - the value for the contextName record component

contextURL - the value for the contextURL record component

entry - the value for the entry record component

generatableElement - the value for the generatableElement record component

Method Details

getModElementFromGUI

public GeneratableElement getModElementFromGUI()

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.

contextName

@Nullable
public String contextName()

Returns the value of the contextName record component.

Specified by:

contextName in interface IHelpContext

Returns:

the value of the contextName record component

contextURL

@Nullable
public URI contextURL()

Returns the value of the contextURL record component.

Specified by:

contextURL in interface IHelpContext

Returns:

the value of the contextURL record component

entry

@Nullable
public String entry()

Returns the value of the entry record component.

Specified by:

entry in interface IHelpContext

Returns:

the value of the entry record component

generatableElement

public Supplier<GeneratableElement> generatableElement()

Returns the value of the generatableElement record component.

Returns:

the value of the generatableElement record component