org.anvilpowered.anvil.api.entity.RestrictionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of anvil-api Show documentation
A cross-platform database API / ORM / entity framework with useful services for minecraft plugins
The newest version!
/*
 *   Anvil - AnvilPowered
 *   Copyright (C) 2020
 *
 *     This program 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 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program 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 program.  If not, see .
 */

package org.anvilpowered.anvil.api.entity;

import java.util.Optional;
import java.util.UUID;

public interface RestrictionService {

    /**
     * 
     * Restricts the provided entity as specified by the provided {@link RestrictionCriteria}, overwriting any
     * previous restrictions.
     * 
     * 

     * 
     * If the provided entity is identifiable by {@link UUID}, the provided {@link RestrictionCriteria}
     * will be registered with said {@link UUID} rather than the provided entity instance.
     * 
     *
     * @param entity   The entity to restrict
     * @param criteria The {@link RestrictionCriteria} to restrict with
     */
    void put(Object entity, RestrictionCriteria criteria);

    /**
     * 
     * Restricts entities identified by the provided {@link UUID} as specified by the provided
     * {@link RestrictionCriteria}, overwriting any previous restrictions.
     * 
     *
     * @param uuid     The uuid of the entity to restrict
     * @param criteria The {@link RestrictionCriteria} to restrict with
     */
    void put(UUID uuid, RestrictionCriteria criteria);

    /**
     * 
     * Stops all restrictions for the provided entity.
     * 
     * 

     * 
     * If the provided entity is identifiable by {@link UUID}, removes all restrictions for entities identified by
     * said {@link UUID}.
     * 
     *
     * @param entity The entity to stop restrictions for
     * @return An {@link Optional} containing the removed {@link RestrictionCriteria} if it existed,
     * otherwise {@link Optional#empty()}
     */
    Optional remove(Object entity);

    /**
     * 
     * Stops all restrictions for entities identified by the provided {@link UUID}.
     * 
     *
     * @param uuid The uuid of the entity to stop restricting
     * @return An {@link Optional} containing the removed {@link RestrictionCriteria} if it existed,
     * otherwise {@link Optional#empty()}
     */
    Optional remove(UUID uuid);

    /**
     * 
     * Checks whether the provided entity is restricted.
     * 
     *
     * @param entity The entity to check
     * @return The {@link RestrictionCriteria} associated with the provided entity, otherwise
     * {@link RestrictionCriteria#none()}
     */
    RestrictionCriteria get(Object entity);

    /**
     * 
     * Checks whether the entity identified by the provided {@link UUID} is restricted.
     * 
     *
     * @param uuid The {@link UUID} of the entity to check
     * @return The {@link RestrictionCriteria} associated with the provided {@link UUID}, otherwise
     * {@link RestrictionCriteria#none()}
     */
    RestrictionCriteria get(UUID uuid);
}