io.github.almightysatan.slams.papi.OfflinePlayerContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of slams-papi Show documentation

Simple Language And Message System

The newest version!

/*
 * SLAMS - Simple Language And Message System
 * Copyright (C) 2023 Almighty-Satan, LeStegii
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

package io.github.almightysatan.slams.papi;

import io.github.almightysatan.slams.Context;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Objects;

/**
 * A {@link Context} that has a {@link OfflinePlayer}.
 */
public interface OfflinePlayerContext extends Context {

    /**
     * Returns the player.
     *
     * @return the player
     */
    @NotNull OfflinePlayer player();

    /**
     * Creates a new {@link OfflinePlayerContext} from the given player.
     *
     * @param offlinePlayer the player
     * @return the context
     */
    static @NotNull OfflinePlayerContext of(@NotNull OfflinePlayer offlinePlayer) {
        Objects.requireNonNull(offlinePlayer);
        return new OfflinePlayerContext() {
            @Override
            public @NotNull OfflinePlayer player() {
                return offlinePlayer;
            }

            @Override
            public @Nullable String language() {
                return null;
            }
        };
    }
}