Record Class PermissionDynamicContextKey<T>

java.lang.Object

java.lang.Record

net.neoforged.neoforge.server.permission.nodes.PermissionDynamicContextKey<T>

public record PermissionDynamicContextKey<T>(Class<T> typeToken, String name, Function<T,String> serializer)
extends Record

Represents a key that can be used to build a PermissionDynamicContext.

Keys, along with their associated values, can be used to provide additional context for a permission handler in determining whether to grant permission for an actor and a specific node.

As an example usage, a dimension context key could be used inside a building permission check to ensure that the actor can build given those constraints.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	name	The field for the name record component.
private final Function<T,String>	serializer	The field for the serializer record component.
private final Class<T>	typeToken	The field for the typeToken record component.

Constructor Summary

Constructors

Constructor	Description
PermissionDynamicContextKey(Class<T> typeToken, String name, Function<T,String> serializer)	Creates an instance of a PermissionDynamicContextKey record class.

Method Summary

Modifier and Type	Method	Description
PermissionDynamicContext<T>	createContext(T value)
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.
Function<T,String>	serializer()	Returns the value of the serializer record component.
final String	toString()	Returns a string representation of this record class.
Class<T>	typeToken()	Returns the value of the typeToken record component.

Methods inherited from class Object

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

Field Details

typeToken

private final Class<T> typeToken

The field for the typeToken record component.

name

private final String name

The field for the name record component.

serializer

private final Function<T,String> serializer

The field for the serializer record component.

Constructor Details

PermissionDynamicContextKey

public PermissionDynamicContextKey(Class<T> typeToken,
 String name,
 Function<T,String> serializer)

Creates an instance of a PermissionDynamicContextKey record class.

Parameters:

typeToken - the value for the typeToken record component

name - the value for the name record component

serializer - the value for the serializer record component

Method Details

createContext

public PermissionDynamicContext<T> createContext(T value)

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.

typeToken

public Class<T> typeToken()

Returns the value of the typeToken record component.

Returns:

the value of the typeToken record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

serializer

public Function<T,String> serializer()

Returns the value of the serializer record component.

Returns:

the value of the serializer record component