Package net.kyori.adventure.text.event

Class HoverEvent.ShowEntity

java.lang.Object

net.kyori.adventure.text.event.HoverEvent.ShowEntity

All Implemented Interfaces:

net.kyori.examination.Examinable

Enclosing class:

HoverEvent<V>

public static final class HoverEvent.ShowEntity
extends java.lang.Object
implements net.kyori.examination.Examinable

The value of a show_entity hover event.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable java.lang.Object other)
@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
int	hashCode()
@NotNull java.util.UUID	id()	Gets the id.
@NotNull HoverEvent.ShowEntity	id(@NotNull java.util.UUID id)	Sets the id.
@Nullable Component	name()	Gets the name.
@NotNull HoverEvent.ShowEntity	name(@Nullable Component name)	Sets the name.
static @NotNull HoverEvent.ShowEntity	of(@NotNull Keyed type, @NotNull java.util.UUID id)	Deprecated. for removal since 4.14.0, use showEntity(Keyed, UUID) instead.
static @NotNull HoverEvent.ShowEntity	of(@NotNull Keyed type, @NotNull java.util.UUID id, @Nullable Component name)	Deprecated. for removal since 4.14.0, use showEntity(Keyed, UUID, Component) instead.
static @NotNull HoverEvent.ShowEntity	of(@NotNull Key type, @NotNull java.util.UUID id)	Deprecated. for removal since 4.14.0, use showEntity(Key, UUID) instead.
static @NotNull HoverEvent.ShowEntity	of(@NotNull Key type, @NotNull java.util.UUID id, @Nullable Component name)	Deprecated. for removal since 4.14.0, use showEntity(Key, UUID, Component) instead.
static @NotNull HoverEvent.ShowEntity	showEntity(@NotNull Keyed type, @NotNull java.util.UUID id)	Creates.
static @NotNull HoverEvent.ShowEntity	showEntity(@NotNull Keyed type, @NotNull java.util.UUID id, @Nullable Component name)	Creates.
static @NotNull HoverEvent.ShowEntity	showEntity(@NotNull Key type, @NotNull java.util.UUID id)	Creates.
static @NotNull HoverEvent.ShowEntity	showEntity(@NotNull Key type, @NotNull java.util.UUID id, @Nullable Component name)	Creates.
java.lang.String	toString()
@NotNull Key	type()	Gets the type.
@NotNull HoverEvent.ShowEntity	type(@NotNull Key type)	Sets the type.
@NotNull HoverEvent.ShowEntity	type(@NotNull Keyed type)	Sets the type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Method Detail

showEntity

@NotNull
public static @NotNull HoverEvent.ShowEntity showEntity(@NotNull
                                                        @NotNull Key type,
                                                        @NotNull
                                                        @NotNull java.util.UUID id)

Creates.

Parameters:

type - the type

id - the id

Returns:

a ShowEntity

Since:

4.14.0

of

@Deprecated
@ScheduledForRemoval(inVersion="5.0.0")
@NotNull
public static @NotNull HoverEvent.ShowEntity of(@NotNull
                                                @NotNull Key type,
                                                @NotNull
                                                @NotNull java.util.UUID id)

Deprecated.

for removal since 4.14.0, use showEntity(Key, UUID) instead.

Creates.

Parameters:

type - the type

id - the id

Returns:

a ShowEntity

Since:

4.0.0

showEntity

@NotNull
public static @NotNull HoverEvent.ShowEntity showEntity(@NotNull
                                                        @NotNull Keyed type,
                                                        @NotNull
                                                        @NotNull java.util.UUID id)

Creates.

Parameters:

type - the type

id - the id

Returns:

a ShowEntity

Since:

4.14.0

of

@Deprecated
@ScheduledForRemoval(inVersion="5.0.0")
@NotNull
public static @NotNull HoverEvent.ShowEntity of(@NotNull
                                                @NotNull Keyed type,
                                                @NotNull
                                                @NotNull java.util.UUID id)

Deprecated.

for removal since 4.14.0, use showEntity(Keyed, UUID) instead.

Creates.

Parameters:

type - the type

id - the id

Returns:

a ShowEntity

Since:

4.6.0

showEntity

@NotNull
public static @NotNull HoverEvent.ShowEntity showEntity(@NotNull
                                                        @NotNull Key type,
                                                        @NotNull
                                                        @NotNull java.util.UUID id,
                                                        @Nullable
                                                        @Nullable Component name)

Creates.

Parameters:

type - the type

id - the id

name - the name

Returns:

a ShowEntity

Since:

4.14.0

of

@Deprecated
@ScheduledForRemoval(inVersion="5.0.0")
@NotNull
public static @NotNull HoverEvent.ShowEntity of(@NotNull
                                                @NotNull Key type,
                                                @NotNull
                                                @NotNull java.util.UUID id,
                                                @Nullable
                                                @Nullable Component name)

Deprecated.

for removal since 4.14.0, use showEntity(Key, UUID, Component) instead.

Creates.

Parameters:

type - the type

id - the id

name - the name

Returns:

a ShowEntity

Since:

4.0.0

showEntity

@NotNull
public static @NotNull HoverEvent.ShowEntity showEntity(@NotNull
                                                        @NotNull Keyed type,
                                                        @NotNull
                                                        @NotNull java.util.UUID id,
                                                        @Nullable
                                                        @Nullable Component name)

Creates.

Parameters:

type - the type

id - the id

name - the name

Returns:

a ShowEntity

Since:

4.14.0

of

@Deprecated
@ScheduledForRemoval(inVersion="5.0.0")
@NotNull
public static @NotNull HoverEvent.ShowEntity of(@NotNull
                                                @NotNull Keyed type,
                                                @NotNull
                                                @NotNull java.util.UUID id,
                                                @Nullable
                                                @Nullable Component name)

Deprecated.

for removal since 4.14.0, use showEntity(Keyed, UUID, Component) instead.

Creates.

Parameters:

type - the type

id - the id

name - the name

Returns:

a ShowEntity

Since:

4.6.0

type

@NotNull
public @NotNull Key type()

Gets the type.

Returns:

the type

Since:

4.0.0

type

@NotNull
public @NotNull HoverEvent.ShowEntity type(@NotNull
                                           @NotNull Key type)

Sets the type.

Parameters:

type - the type

Returns:

a ShowEntity

Since:

4.0.0

type

@NotNull
public @NotNull HoverEvent.ShowEntity type(@NotNull
                                           @NotNull Keyed type)

Sets the type.

Parameters:

type - the type

Returns:

a ShowEntity

Since:

4.6.0

id

@NotNull
public @NotNull java.util.UUID id()

Gets the id.

Returns:

the id

Since:

4.0.0

id

@NotNull
public @NotNull HoverEvent.ShowEntity id(@NotNull
                                         @NotNull java.util.UUID id)

Sets the id.

Parameters:

id - the id

Returns:

a ShowEntity

Since:

4.0.0

name

@Nullable
public @Nullable Component name()

Gets the name.

Returns:

the name

Since:

4.0.0

name

@NotNull
public @NotNull HoverEvent.ShowEntity name(@Nullable
                                           @Nullable Component name)

Sets the name.

Parameters:

name - the name

Returns:

a ShowEntity

Since:

4.0.0

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

examinableProperties

@NotNull
public @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object