org.spongepowered.api.profile.property.ProfileProperty 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
The newest version!
/*
 * 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.profile.property;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.spongepowered.api.Sponge;
import org.spongepowered.api.data.Keys;
import org.spongepowered.api.data.persistence.DataSerializable;
import org.spongepowered.api.entity.living.Humanoid;
import org.spongepowered.api.profile.GameProfile;

import java.util.Optional;

/**
 * Represents a property in a {@link GameProfile}'s profile property map.
 *
 * This interface should not be implemented by third parties - use
 * {@link #of(String, String)} or {@link #of(String, String, String)} to
 * create instances instead.
 *
 * @see #of(String, String)
 * @see #of(String, String, String)
 */
public interface ProfileProperty extends DataSerializable {

    /**
     * The name of the {@code textures} property.
     *
     * This is used with {@link Keys#SKIN_PROFILE_PROPERTY} to set the skin of a {@link Humanoid}.
     */
    String TEXTURES = "textures";

    /**
     * Creates a new property.
     *
     * @param name The name for the property
     * @param value The value of the property
     * @return The new property
     */
    static ProfileProperty of(final String name, final String value) {
        return ProfileProperty.of(name, value, null);
    }

    /**
     * Creates a new signed property.
     *
     * Depending on the property name, if the signature is provided it must
     * originate from Mojang.
     *
     * @param name The name for the property
     * @param value The value of the property
     * @param signature The signature of the property
     * @return The new property
     */
    static ProfileProperty of(final String name, final String value, final @Nullable String signature) {
        return Sponge.game().factoryProvider().provide(Factory.class).of(name, value, signature);
    }

    /**
     * Gets the name of this property.
     *
     * @return The name
     */
    String name();

    /**
     * Gets the value of this property.
     *
     * @return The value
     */
    String value();

    /**
     * Gets the signature of this property.
     *
     * Depending on the property name, if the signature is provided it must
     * originate from Mojang.
     *
     * @return The signature, or {@link Optional#empty()} if not present
     */
    Optional signature();

    /**
     * Tests if this property has a signature.
     *
     * @return Whether this property has a signature
     */
    default boolean hasSignature() {
        return this.signature().isPresent();
    }

    /**
     * A factory for {@link ProfileProperty}s.
     */
    interface Factory {

        ProfileProperty of(String name, String value, @Nullable String signature);
    }
}