/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q <http://www.sk89q.com>
 * Copyright (C) WorldEdit team and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package com.sk89q.worldedit.registry;

import com.sk89q.worldedit.internal.util.DeprecationUtil;
import com.sk89q.worldedit.internal.util.NonAbstractForCompatibility;

/**
 * Represents an objects that can be added to a registry and referenced by an id which is unique within its registry.
 */
public interface Keyed {

    /**
     * The id of this object in the registry. Must be unique, and lowercase. Certain registries (e.g Namespaced ones) may have additional restrictions.
     *
     * @return an id
     * @deprecated Use {@link #id()} instead.
     */
    @Deprecated(forRemoval = true, since = "2.11.0")
    default String getId() {
        return id();
    }

    /**
     * The id of this object in the registry. Must be unique and lowercase. Certain registries (e.g namespaced ones)
     * may have additional restrictions.
     *
     * @return an id
     * @since 2.11.0
     */
    @NonAbstractForCompatibility(delegateName = "getId", delegateParams = {})
    default String id() {
        DeprecationUtil.checkDelegatingOverride(getClass());
        return getId();
    }

}
