Package ch.njol.skript.classes

Record Class ClassInfo.PropertyDocs

java.lang.Object

java.lang.Record

ch.njol.skript.classes.ClassInfo.PropertyDocs

Enclosing class:

ClassInfo<T>

@Experimental
public static record ClassInfo.PropertyDocs(Property<?> property, String description, SkriptAddon provider)
extends Record

Constructor Summary

Constructors

Constructor	Description
PropertyDocs(Property<?> property, String description, SkriptAddon provider)	Creates an instance of a PropertyDocs record class.

Method Summary

Modifier and Type	Method	Description
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.
Property<?>	property()	Returns the value of the property record component.
SkriptAddon	provider()	Returns the value of the provider 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

PropertyDocs

public PropertyDocs(Property<?> property,
 String description,
 SkriptAddon provider)

Creates an instance of a PropertyDocs record class.

Parameters:

property - the value for the property record component

description - the value for the description record component

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

property

public Property<?> property()

Returns the value of the property record component.

Returns:

the value of the property record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

provider

public SkriptAddon provider()

Returns the value of the provider record component.

Returns:

the value of the provider record component