org.spongepowered.api.service.economy

Interface EconomyService

All Superinterfaces:

ContextualService<Account>

public interface EconomyService
extends ContextualService<Account>

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.

Method Summary

Modifier and Type	Method and Description
default AccountDeletionResultType	deleteAccount(String identifier) Deletes the account with the specified identifier.
default AccountDeletionResultType	deleteAccount(UUID uuid) Deletes the account for the user with the specified UUID.
Set<Currency>	getCurrencies() Returns the Set of supported Currency objects that are implemented by this EconomyService.
Currency	getDefaultCurrency() Retrieves the default Currency used by the EconomyService.
Optional<Account>	getOrCreateAccount(String identifier) Gets the VirtualAccount with the specified identifier.
Optional<UniqueAccount>	getOrCreateAccount(UUID uuid) Gets the UniqueAccount for the user with the specified UUID.
boolean	hasAccount(String identifier) Returns whether an Account with the specified identifier exists.
boolean	hasAccount(UUID uuid) Returns whether a UniqueAccount exists with the specified UUID.

Methods inherited from interface org.spongepowered.api.service.context.ContextualService

registerContextCalculator

Method Detail

getDefaultCurrency

Currency getDefaultCurrency()

Retrieves the default Currency used by the EconomyService.

Returns:

Currency default for the EconomyService

See Also:

Currency

getCurrencies

Set<Currency> getCurrencies()

Returns the Set of supported Currency objects that are implemented by this EconomyService.

The economy service provider may only support one currency, in which case getDefaultCurrency() will be the only member of the set.

The set returned is a read-only a view of all currencies available in the EconomyService.

Returns:

The Set of all Currencys

hasAccount

boolean hasAccount(UUID uuid)

Returns whether a UniqueAccount exists with the specified UUID.

Parameters:

uuid - The UUID of the account to check for

Returns:

Whether a UniqueAccount exists with the specified UUID

hasAccount

boolean hasAccount(String identifier)

Returns whether an Account with the specified identifier exists.

Depending on the implementation, the Account may be a UniqueAccount or a VirtualAccount.

Parameters:

identifier - The identifier of the account to check for

Returns:

Whether an Account with the specified identifier exists

getOrCreateAccount

Optional<UniqueAccount> getOrCreateAccount(UUID uuid)

Gets the UniqueAccount for the user with the specified UUID.

If an account does not already exist with the specified UUID, it will be created.

Creation might fail if the provided UUID does not correspond to an actual player, or for an implementation-defined reason.

Parameters:

uuid - The UUID of the account to get.

Returns:

The UniqueAccount, if available.

getOrCreateAccount

Optional<Account> getOrCreateAccount(String identifier)

Gets the VirtualAccount with the specified identifier.

Depending on the implementation, the Account may be a UniqueAccount or a VirtualAccount.

If an account does not already exist with the specified identifier, it will be created.

Creation may fail for an implementation-defined reason.

Parameters:

identifier - The identifier of the account to get.

Returns:

The Account, if available.

deleteAccount

default AccountDeletionResultType deleteAccount(UUID uuid)

Deletes the account for the user with the specified UUID.

Deletion might fail if the provided UUID does not correspond to an actual player, or for some other implementation-defined reason.

Parameters:

uuid - The UUID of the account to delete.

Returns:

The result of the deletion.

deleteAccount

default AccountDeletionResultType deleteAccount(String identifier)

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.

Parameters:

identifier - The identifier of the account to delete.

Returns:

The result of the deletion.