org.spongepowered.api.service.economy.EconomyService Maven / Gradle / Ivy
Show all versions of spongeapi Show documentation
/*
* 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.service.economy;
import org.spongepowered.api.service.economy.account.Account;
import org.spongepowered.api.service.economy.account.AccountDeletionResultType;
import org.spongepowered.api.service.economy.account.UniqueAccount;
import org.spongepowered.api.service.economy.account.VirtualAccount;
import java.util.Collection;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Stream;
/**
* Represents a service for managing a server economy.
*
* Unlike other services provided by the API, the economy service
* does **not** have an implementation registered by default. Since Vanilla has
* no concept of economy, the economy service implementation must always be
* provided by a plugin. This service exists to provide a common API which
* can be used by implementors and consumers.
*/
public interface EconomyService {
/**
* Retrieves the default {@link Currency} used by the
* {@link EconomyService}.
*
* @return {@link Currency} default for the EconomyService
*
* @see Currency
*/
Currency defaultCurrency();
/**
* Returns whether a {@link UniqueAccount} exists with the specified
* {@link UUID}.
*
* @param uuid The {@link UUID} of the account to check for
* @return Whether a {@link UniqueAccount} exists with the specified
* {@link UUID}
*/
boolean hasAccount(UUID uuid);
/**
* Returns whether an {@link Account} with the specified identifier exists.
*
* Depending on the implementation, the {@link Account} may be a
* {@link UniqueAccount} or a {@link VirtualAccount}.
*
* @param identifier The identifier of the account to check for
* @return Whether an {@link Account} with the specified identifier exists
*/
boolean hasAccount(String identifier);
/**
* Gets the {@link UniqueAccount} for the user with the specified
* {@link UUID}.
*
*
If an account does not already exist with the specified {@link UUID},
* it will be created.
*
* Creation might fail if the provided {@link UUID} does not correspond
* to an actual player, or for an implementation-defined reason.
*
* @param uuid The {@link UUID} of the account to get.
* @return The {@link UniqueAccount}, if available.
*/
Optional findOrCreateAccount(UUID uuid);
/**
* Gets the {@link VirtualAccount} with the specified identifier.
*
* Depending on the implementation, the {@link Account} may be a
* {@link UniqueAccount} or a {@link VirtualAccount}.
*
* If an account does not already exist with the specified identifier,
* it will be created.
*
* Creation may fail for an implementation-defined reason.
*
* @param identifier The identifier of the account to get.
* @return The {@link Account}, if available.
*/
Optional findOrCreateAccount(String identifier);
/**
* Gets a {@link Stream} of all available {@link UniqueAccount}s.
*
* @return A stream of all {@link UniqueAccount}s.
*/
Stream streamUniqueAccounts();
/**
* Gets a {@link Collection} of all available {@link UniqueAccount}s.
*
* @return A Collection of all {@link UniqueAccount}s.
*/
Collection uniqueAccounts();
/**
* Gets a {@link Stream} of all available {@link VirtualAccount}s.
*
* @return A stream of all {@link VirtualAccount}s.
*/
Stream streamVirtualAccounts();
/**
* Gets a {@link Collection} of all available {@link VirtualAccount}s.
*
* @return A Collection of all {@link VirtualAccount}s.
*/
Collection virtualAccounts();
/**
* Deletes the account for the user with the specified {@link UUID}.
*
* Deletion might fail if the provided {@link UUID} does not correspond
* to an actual player, or for some other implementation-defined reason.
*
* @param uuid The {@link UUID} of the account to delete.
* @return The result of the deletion.
*/
AccountDeletionResultType deleteAccount(UUID uuid);
/**
* Deletes the account with the specified identifier.
*
* If an account exists with the specified identifier,
* it will be deleted.
*
* Deletion may fail for an implementation-defined reason.
*
* @param identifier The identifier of the account to delete.
* @return The result of the deletion.
*/
AccountDeletionResultType deleteAccount(String identifier);
}