org.spongepowered.api.world.gamerule.GameRule 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.gamerule;

import io.leangen.geantyref.TypeToken;
import org.spongepowered.api.registry.DefaultedRegistryValue;
import org.spongepowered.api.util.Nameable;
import org.spongepowered.api.util.annotation.CatalogedBy;

import java.lang.reflect.Type;

/**
 * Represents a game rule.
 *
 * @param  The type of the value
 */
@CatalogedBy(GameRules.class)
public interface GameRule extends DefaultedRegistryValue, Nameable {

    /**
     * Gets the value {@link TypeToken type}.
     *
     * @return The value type
     */
    Type valueType();

    /**
     * Gets the default value.
     *
     * @return The default value
     */
    V defaultValue();

    // TODO: Command argument parser

    interface Builder extends org.spongepowered.api.util.Builder, Builder> {

        // TODO: Command argument parser

        /**
         * Sets the name of the game rule.
         *
         * @param name The name
         * @return This builder for chaining
         */
        Builder name(String name);

        /**
         * Sets the value type.
         *
         * This must not be a raw parameterized type.
         *
         * @param valueType The value type
         * @param  The value type
         * @return This builder, for chaining
         */
         Builder valueType(final Class valueType);

        /**
         * Sets the value {@link TypeToken type}.
         *
         * @param valueType The value type
         * @param  The value type
         * @return This builder, for chaining
         */
         Builder valueType(TypeToken valueType);

        /**
         * Sets the default value.
         *
         * Must be called after {@link #valueType(TypeToken)}.
         *
         * @param defaultValue The default value
         * @return This builder, for chaining
         */
        Builder defaultValue(V defaultValue);

        /**
         * Builds the {@link GameRule}.
         *
         * @return The built game rule
         * @throws IllegalStateException If not all required options were specified; {@link #valueType(TypeToken)}, {@link #defaultValue(Object)}.
         */
        @Override
        GameRule build() throws IllegalStateException;
    }
}