Module io.github.miniplaceholders.api

Package io.github.miniplaceholders.api.placeholder

Record Class GlobalPlaceholder

java.lang.Object

java.lang.Record

io.github.miniplaceholders.api.placeholder.GlobalPlaceholder

Record Components:

key - the placeholder key

name - the placeholder name

resolver - the object responsible for providing information

All Implemented Interfaces:

Placeholder, TagResolver

public record GlobalPlaceholder(String key, String name, GlobalTagResolver resolver)
extends Record
implements Placeholder

A placeholder that can obtain data without the need to provide an Audience or RelationalAudience.

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver

TagResolver.Builder, TagResolver.Single, TagResolver.WithoutArguments

Constructor Summary

Constructors

Constructor	Description
GlobalPlaceholder(String key, String name, GlobalTagResolver resolver)	Creates an instance of a GlobalPlaceholder record class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
boolean	has(@NotNull String name)
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
String	name()	Returns the value of the name record component.
@Nullable Tag	resolve(@NotNull String name, @NotNull ArgumentQueue arguments, @NotNull Context ctx)
GlobalTagResolver	resolver()	Returns the value of the resolver record component.
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

GlobalPlaceholder

public GlobalPlaceholder(@TagPattern
 String key,
 String name,
 GlobalTagResolver resolver)

Creates an instance of a GlobalPlaceholder record class.

Parameters:

key - the value for the key record component

name - the value for the name record component

resolver - the value for the resolver record component

Method Details

resolve

@Nullable
public @Nullable Tag resolve(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull ArgumentQueue arguments,
 @NotNull
 @NotNull Context ctx)

Specified by:

resolve in interface TagResolver

has

public boolean has(@NotNull
 @NotNull String name)

Specified by:

has in interface TagResolver

equals

public boolean equals(Object obj)

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:

obj - the object with which to compare

Returns:

true if this object is the same as the obj argument; false otherwise.

toString

public 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

key

@TagPattern
public String key()

Returns the value of the key record component.

Specified by:

key in interface Placeholder

Returns:

the value of the key record component

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface Placeholder

Returns:

the value of the name record component

resolver

public GlobalTagResolver resolver()

Returns the value of the resolver record component.

Returns:

the value of the resolver record component