net.minestom.server.utils.identity.NamedAndIdentified Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of minestom-snapshots Show documentation

1.20.4 Lightweight Minecraft server

There is a newer version: 7320437640

package net.minestom.server.utils.identity;

import net.kyori.adventure.text.Component;
import org.jetbrains.annotations.NotNull;

import java.util.UUID;

/**
 * An object with a {@link Component} name and a {@link UUID} identity.
 */
public interface NamedAndIdentified {

    /**
     * Creates a {@link NamedAndIdentified} instance with an empty name and a random UUID.
     *
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified empty() {
        return of(Component.empty(), UUID.randomUUID());
    }

    /**
     * Creates a {@link NamedAndIdentified} instance with a given name and a random UUID.
     *
     * @param name the name
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified named(@NotNull String name) {
        return of(name, UUID.randomUUID());
    }

    /**
     * Creates a {@link NamedAndIdentified} instance with a given name and a random UUID.
     *
     * @param name the name
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified named(@NotNull Component name) {
        return of(name, UUID.randomUUID());
    }

    /**
     * Creates a {@link NamedAndIdentified} instance with an empty name and a given UUID.
     *
     * @param uuid the uuid
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified identified(@NotNull UUID uuid) {
        return of(Component.empty(), uuid);
    }

    /**
     * Creates a {@link NamedAndIdentified} instance with a given name and UUID.
     *
     * @param name the name
     * @param uuid the uuid
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified of(@NotNull String name, @NotNull UUID uuid) {
        return new NamedAndIdentifiedImpl(name, uuid);
    }

    /**
     * Creates a {@link NamedAndIdentified} instance with a given name and UUID.
     *
     * @param name the name
     * @param uuid the uuid
     * @return the named and identified instance
     */
    static @NotNull NamedAndIdentified of(@NotNull Component name, @NotNull UUID uuid) {
        return new NamedAndIdentifiedImpl(name, uuid);
    }

    /**
     * Gets the name of this object.
     *
     * @return the name
     */
    @NotNull Component getName();

    /**
     * Gets the UUID of this object.
     *
     * @return the uuid
     */
    @NotNull UUID getUuid();
}