org.spongepowered.api.world.schematic.Palette Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
There is a newer version: 9.0.0
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) 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 org.spongepowered.api.world.schematic;

import org.spongepowered.api.registry.RegistryHolder;

import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.stream.Stream;

/**
 * Represents a mapping for types to a local identifier. Can be used for
 * mapping {@code Object}s to {@code int} id's for storage purposes,
 * or for converting stored information to a representable format back into
 * {@link Object}s.
 *
 * @param  The type this palette will maintain
 * @param  The type of registry used to build this palette
 */
public interface Palette {

    /**
     * Gets the type of this palette.
     *
     * @return The palette type
     */
    PaletteType type();

    /**
     * Gets the highest identifier in this palette.
     *
     * @return The highest id
     */
    int highestId();

    /**
     * Gets the {@code type} represented by the given identifier from the mapping.
     *
     * @param id The identifier
     * @return The type, if found
     */
    Optional> get(int id);

    default Optional get(final int id, final RegistryHolder holder) {
        return this.get(id).flatMap(ref -> Objects.requireNonNull(holder, "RegistryHolder cannot be null")
            .findRegistry(ref.registry())
            .flatMap(reg -> this.type().resolver().apply(ref.value(), reg)));
    }

    /**
     * Gets the identifier for the given {@code type T} if it exists within the
     * mapping.
     *
     * @param type The type
     * @return The identifier, if found
     */
    OptionalInt get(T type);

    /**
     * Gets all {@code type T}s contained in this palette.
     *
     * @return All contained types
     */
    Stream stream();

    Stream> streamWithIds();

    Mutable asMutable(RegistryHolder registry);

    Immutable asImmutable();

    interface Mutable extends Palette {

        /**
         * Gets the identifier for the given {@code type T} from the mapping. If the
         * {@code type T} is not yet registered in the mapping then it is registered and
         * given the next available identifier.
         *
         * @param type The type
         * @return The identifier
         */
        int orAssign(M type);

        /**
         * Removes the given {@code type T} from the mapping.
         *
         * Note that if this palette is considered a global palette, removal is not supported.
         *
         * @param type The type to remove
         * @return If the type existed in the mapping
         */
        boolean remove(M type);

        @Override
        default Mutable asMutable(final RegistryHolder registry) {
            return this;
        }
    }

    interface Immutable extends Palette {

        @Override
        default Immutable asImmutable() {
            return this;
        }
    }

}