/*
 * This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
 * Copyright (C) 2016-2024 ViaVersion and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.viaversion.viaversion.api.minecraft;

/**
 * Set of ids that either holds a string tag key or an array of ids.
 */
public interface HolderSet {

    /**
     * Creates a new holder set for the given tag.
     *
     * @param tagKey the tag key
     * @return a new holder set
     */
    static HolderSet of(final String tagKey) {
        return new HolderSetImpl(tagKey);
    }

    /**
     * Creates a new holder set for the given ids.
     *
     * @param ids the direct ids
     * @return a new holder set
     */
    static HolderSet of(final int[] ids) {
        return new HolderSetImpl(ids);
    }

    /**
     * Gets the tag key.
     *
     * @return the tag key
     * @see #hasTagKey()
     */
    String tagKey();

    /**
     * Returns whether this holder set has a tag key.
     *
     * @return true if this holder set has a tag key, false if it has direct ids
     */
    boolean hasTagKey();

    /**
     * Gets the direct ids.
     *
     * @return direct ids
     * @see #hasIds()
     */
    int[] ids();

    /**
     * Returns whether this holder set has direct ids.
     *
     * @return true if this holder set has direct ids, false if it has a tag key
     */
    boolean hasIds();
}