org.spongepowered.api.text.action

Class HoverAction.ShowEntity.Ref

java.lang.Object

org.spongepowered.api.text.action.HoverAction.ShowEntity.Ref

All Implemented Interfaces:

Identifiable

Enclosing class:

HoverAction.ShowEntity

public static final class HoverAction.ShowEntity.Ref
extends Object
implements Identifiable

Represents a reference to an entity, used in the underlying JSON of the show entity action.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Ref(Entity entity, String name) Constructs a Ref, given an Entity.
	Ref(UUID uuid, String name) Constructs a Ref to an entity.
	Ref(UUID uuid, String name, EntityType type) Constructs a Ref to an entity.
protected	Ref(UUID uuid, String name, Optional<EntityType> type) Constructs a Ref directly.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Retrieves the name that this HoverAction.ShowEntity.Ref refers to.
Optional<EntityType>	getType() Retrieves the type that this HoverAction.ShowEntity.Ref refers to, if it exists.
UUID	getUniqueId() Retrieves the UUID that this HoverAction.ShowEntity.Ref refers to.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Ref

public Ref(UUID uuid,
           String name,
           @Nullable
           EntityType type)

Constructs a Ref to an entity.

Parameters:

uuid - The UUID of the entity

name - The name of the entity

type - The type of the entity

Ref

public Ref(UUID uuid,
           String name)

Constructs a Ref to an entity.

Parameters:

uuid - The UUID of the entity

name - The name of the entity

Ref

public Ref(Entity entity,
           String name)

Constructs a Ref, given an Entity.

Parameters:

entity - The entity

name - The name of the entity

Ref

protected Ref(UUID uuid,
              String name,
              Optional<EntityType> type)

Constructs a Ref directly.

Parameters:

uuid - The UUID

name - The name

type - The type

Method Detail

getUniqueId

public UUID getUniqueId()

Retrieves the UUID that this HoverAction.ShowEntity.Ref refers to.

Specified by:

getUniqueId in interface Identifiable

Returns:

The UUID

getName

public String getName()

Retrieves the name that this HoverAction.ShowEntity.Ref refers to.

Returns:

The name

getType

public Optional<EntityType> getType()

Retrieves the type that this HoverAction.ShowEntity.Ref refers to, if it exists.

Returns:

The type, or Optional.empty()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object