org.anvilpowered.anvil.api.util.UserService 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.util;

import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;

/**
 * Service for translating UUIDs to UserNames or UserNames to UUIDs
 */
public interface UserService {

    Optional get(String userName);

    Optional get(UUID userUUID);

    Optional getPlayer(String userName);

    Optional getPlayer(UUID userUUID);

    Optional getPlayer(TUser user);

    /**
     * Attempts to find all matching userNames that start with the provided String (case-insensitive).
     *
     * @return A list of matching player names
     */
    List matchPlayerNames(String startsWith);

    /**
     * Attempts to find all matching userNames that start with the String at the provided index
     * of the provided array when it has the provided length.
     *
     * @param length The length of {@code context} for which to match the String at {@code index}
     * @return A list of matching player names
     */
    List matchPlayerNames(String[] context, int index, int length);

    Collection getOnlinePlayers();

    CompletableFuture> getUUID(String userName);

    CompletableFuture> getUserName(UUID userUUID);

    UUID getUUID(TUser user);

    /**
     * If the provided object has a {@link UUID}, return it. Otherwise return a constant UUID that is
     * the same for all objects without a UUID.
     */
    UUID getUUIDSafe(Object object);

    String getUserName(TUser user);
}