org.spongepowered.api.data.value.SetValue 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.data.value;

import org.spongepowered.api.data.Key;

import java.util.Set;
import java.util.function.Supplier;

public interface SetValue extends CollectionValue> {

    /**
     * Constructs a mutable {@link SetValue} of the appropriate type based
     * on the given {@link Key} and the element.
     *
     * @param key The key
     * @param element The element
     * @param  The element type
     * @return The constructed mutable value
     */
    static  SetValue.Mutable mutableOf(Key> key, Set element) {
        return Value.mutableOf(key, element);
    }

    /**
     * Constructs a mutable {@link SetValue} of the appropriate type based
     * on the given {@link Key} and the element.
     *
     * @param key The key
     * @param element The element
     * @param  The element type
     * @return The constructed mutable value
     */
    static  SetValue.Mutable mutableOf(Supplier>> key, Set element) {
        return SetValue.mutableOf(key.get(), element);
    }

    /**
     * Constructs an immutable {@link SetValue} of the appropriate type based
     * on the given {@link Key} and the element.
     *
     * @param key The key
     * @param element The element
     * @param  The element type
     * @return The constructed immutable value
     */
    static  SetValue.Immutable immutableOf(Key> key, Set element) {
        return Value.immutableOf(key, element);
    }

    /**
     * Constructs an immutable {@link SetValue} of the appropriate type based
     * on the given {@link Key} and the element.
     *
     * @param key The key
     * @param element The element
     * @param  The element type
     * @return The constructed immutable value
     */
    static  SetValue.Immutable immutableOf(Supplier>> key, Set element) {
        return SetValue.immutableOf(key.get(), element);
    }

    @Override
    Key> key();

    @Override
    SetValue.Mutable asMutable();

    @Override
    SetValue.Mutable asMutableCopy();

    @Override
    SetValue.Immutable asImmutable();

    /**
     * Represents a type of {@link org.spongepowered.api.data.value.CollectionValue.Mutable} backed by a {@link Set}. The
     * reasoning is that a {@link Set} retains no ordering of the elements it
     * contains.
     *
     * @param  The type of elements supported
     */
    interface Mutable extends SetValue, CollectionValue.Mutable, Mutable, Immutable> {

        @Override
        default SetValue.Mutable asMutable() {
            return this;
        }

        @Override
        default SetValue.Mutable asMutableCopy() {
            return this.copy();
        }

        @Override
        SetValue.Immutable asImmutable();
    }

    /**
     * Represents a type of {@link org.spongepowered.api.data.value.CollectionValue.Immutable} backed by a
     * {@link Set}. The reasoning is that a {@link Set} retains no ordering of the
     * elements it contains.
     *
     * @param  The type of elements supported
     */
    interface Immutable extends SetValue, CollectionValue.Immutable, Immutable, Mutable> {

        @Override
        SetValue.Mutable asMutable();

        @Override
        default SetValue.Mutable asMutableCopy() {
            return this.asMutable();
        }

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