org.incendo.cloud.minecraft.modded.caption.MinecraftVariable Maven / Gradle / Ivy

Go to download
//
// MIT License
//
// Copyright (c) 2024 Incendo
//
// 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.incendo.cloud.minecraft.modded.caption;

import net.minecraft.network.chat.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.immutables.value.Value;
import org.incendo.cloud.caption.CaptionVariable;
import org.incendo.cloud.internal.ImmutableImpl;

@ImmutableImpl
@Value.Immutable
@SuppressWarnings("immutables:subtype")
public interface MinecraftVariable extends CaptionVariable {
    @Override
    @NonNull String key();

    @Override
    default @NonNull String value() {
        return this.componentValue().getString();
    }

    /**
     * Component {@link #value()}.
     *
     * @return component value
     */
    @NonNull Component componentValue();

    /**
     * Creates a new {@link MinecraftVariable}.
     *
     * @param key   key
     * @param value value
     * @return new variable
     */
    static MinecraftVariable of(final @NonNull String key, final @NonNull Component value) {
        return MinecraftVariableImpl.of(key, value);
    }
}