me.lucko.luckperms.api.FullySatisfiedContexts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of luckperms-api Show documentation
An advanced permissions plugin for Bukkit/Spigot, BungeeCord, Sponge, Nukkit and Velocity.
The newest version!
/*
 * This file is part of LuckPerms, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) 
 *  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 me.lucko.luckperms.api;

import me.lucko.luckperms.api.caching.CachedData;
import me.lucko.luckperms.api.caching.MetaContexts;
import me.lucko.luckperms.api.context.ImmutableContextSet;

import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * A special instance of {@link Contexts}, which when passed to:
 *
 * 
 * 
 *     {@link CachedData#getPermissionData(Contexts)}
 *     {@link CachedData#getMetaData(Contexts)}
 *     {@link CachedData#getMetaData(MetaContexts)}
 * 
 *
 * ... will always satisfy all contextual requirements.
 *
 * This effectively allows you to do lookups which ignore context.
 *
 * @since 3.3
 */
public final class FullySatisfiedContexts extends Contexts {

    // singleton
    private static final FullySatisfiedContexts INSTANCE = new FullySatisfiedContexts();

    public static @NonNull Contexts getInstance() {
        return INSTANCE;
    }

    private FullySatisfiedContexts() {
        super(ImmutableContextSet.empty(), LookupSetting.createFlag(Contexts.global().getSettings()));
    }

    @Override
    public @NonNull String toString() {
        return "FullySatisfiedContexts()";
    }

    @Override
    public boolean equals(Object o) {
        // this class is a singleton, so we can use object comparison to check equality.
        return o == this;
    }

    @Override
    public int hashCode() {
        // just use the system hashcode - we need to override the hashcode impl in super
        return System.identityHashCode(this);
    }
}