Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Account - Interface in me.lokka30.treasury.api.economy.account
-
An Account is something that holds a balance and is associated with something bound by a UUID.
- ACCOUNT_ALREADY_EXISTS - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to an
Account
already existing, whilst attempting to create one with the same identifier. - ACCOUNT_NOT_FOUND - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to the inability to locate an
Account
. - AccountPermission - Enum in me.lokka30.treasury.api.economy.account
-
Enum that holds the permissions of an
Account
that is shared among multiple players. - AccountTransactionEvent - Class in me.lokka30.treasury.api.economy.events
-
Represents an event, called when an account does a
EconomyTransaction
- AccountTransactionEvent(EconomyTransaction, Account) - Constructor for class me.lokka30.treasury.api.economy.events.AccountTransactionEvent
- add(T) - Method in class me.lokka30.treasury.api.common.misc.SortedList
- ALL_PERMISSIONS_MAP - Static variable in interface me.lokka30.treasury.api.economy.account.PlayerAccount
- allServicesFor(Class<T>) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
- asBoolean() - Method in enum me.lokka30.treasury.api.common.misc.TriState
-
Returns this value as a
boolean
. - asFuture(Consumer<? super Subscriber<T, E>>) - Static method in interface me.lokka30.treasury.api.common.response.Subscriber
-
Wrap a method accepting an
Subscriber
in aCompletableFuture
. - asFuture(Consumer<EconomySubscriber<T>>) - Static method in interface me.lokka30.treasury.api.economy.response.EconomySubscriber
-
Wrap a method accepting an
EconomySubscriber
in aCompletableFuture
.
B
- BALANCE - Enum constant in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Allows a player to see the balance of the
Account
. - build() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Builds the specified stuff into a new
EconomyTransaction
- Builder() - Constructor for class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
- Builder(EconomyTransaction.Builder) - Constructor for class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Creates a new
EconomyTransaction.Builder
out of the specifiedother
- BUKKIT_TRANSACTION_EVENTS - Enum constant in enum me.lokka30.treasury.api.economy.misc.OptionalEconomyApiFeature
-
Deprecated.
C
- canAfford(BigDecimal, Currency, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Check if the
Account
can afford a withdrawal of a certain amount. - Cancellable - Interface in me.lokka30.treasury.api.common.event
-
An interface, which can be implemented by events which should be cancellable.
- compareTo(Service<?>) - Method in class me.lokka30.treasury.api.common.service.Service
- compareTo(EventSubscriber<T>) - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
- complete() - Method in class me.lokka30.treasury.api.common.event.Completion
-
Completes this
Completion
. - complete(T) - Method in class me.lokka30.treasury.api.common.event.FireCompletion
-
Successfully completes this completion with the specified result.
- completed() - Static method in class me.lokka30.treasury.api.common.event.Completion
-
Returns a completed
Completion
- completedExceptionally(Throwable) - Static method in class me.lokka30.treasury.api.common.event.Completion
- completedExceptionally(Collection<Throwable>) - Static method in class me.lokka30.treasury.api.common.event.Completion
-
Returns a completed
Completion
which is exceptionally completed with the specifiedCollection
ofThrowables
errors
- completeExceptionally(Throwable) - Method in class me.lokka30.treasury.api.common.event.Completion
- completeExceptionally(Collection<Throwable>) - Method in class me.lokka30.treasury.api.common.event.Completion
- completeExceptionally(Collection<Throwable>) - Method in class me.lokka30.treasury.api.common.event.FireCompletion
- completeSubscription() - Method in class me.lokka30.treasury.api.common.event.EventBus.EventSubscriberBuilder
-
Builds the specified parameters in this builder into a
EventSubscriber
- Completion - Class in me.lokka30.treasury.api.common.event
-
Represents a state of completion.
- Completion() - Constructor for class me.lokka30.treasury.api.common.event.Completion
-
Creates a new
Completion
which is not completed. - copy() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Creates a copy of this
Builder
- createAccount(String, EconomySubscriber<Account>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request the creation of a
Account
for a specific identifier. - createAccount(String, String, EconomySubscriber<Account>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
- createInitiator(EconomyTransactionInitiator.Type, T) - Static method in interface me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator
-
Creates a new
EconomyTransactionInitiator
- createPlayerAccount(UUID, EconomySubscriber<PlayerAccount>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request the creation of a
PlayerAccount
for a user. - Currency - Interface in me.lokka30.treasury.api.economy.currency
-
One of Treasury's core features is multi-currency support.
- CURRENCY_ALREADY_REGISTERED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to the
Currency
already being registered by the economy provider. - CURRENCY_NOT_FOUND - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to the inability to locate a
Currency
.
D
- deleteAccount(EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Delete data stored for the
Account
. - DEPOSIT - Enum constant in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Allows a player to deposit on the
Account
. - DEPOSIT - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionType
-
The Account's new balance is greater than their previous balance.
- depositBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Deposit an amount into the
Account
balance. - depositBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomyTransactionImportance, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Deposit an amount into the
Account
balance. - depositBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomyTransactionImportance, String, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Deposit an amount into the
Account
balance. - doTransaction(EconomyTransaction, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Does a
EconomyTransaction
on this account.
E
- EconomyAPIVersion - Enum in me.lokka30.treasury.api.economy.misc
-
Deprecated.API versions are no longer used as of Treasury v1.1.0.
- EconomyException - Exception in me.lokka30.treasury.api.economy.response
-
An exception for economic problems.
- EconomyException(FailureReason) - Constructor for exception me.lokka30.treasury.api.economy.response.EconomyException
-
Construct a new
EconomyException
. - EconomyException(FailureReason, String) - Constructor for exception me.lokka30.treasury.api.economy.response.EconomyException
-
Construct a new
EconomyException
. - EconomyException(FailureReason, String, Throwable) - Constructor for exception me.lokka30.treasury.api.economy.response.EconomyException
-
Construct a new
EconomyException
. - EconomyException(FailureReason, Throwable) - Constructor for exception me.lokka30.treasury.api.economy.response.EconomyException
-
Construct a new
EconomyException
. - EconomyFailureReason - Enum in me.lokka30.treasury.api.economy.response
- EconomyProvider - Interface in me.lokka30.treasury.api.economy
-
Implementors providing and managing economy data create a class which implements this interface to be registered in the specific platform they're implementing it for.
- EconomySubscriber<T> - Interface in me.lokka30.treasury.api.economy.response
-
An interface accepting responses from an economic provider.
- EconomyTransaction - Class in me.lokka30.treasury.api.economy.transaction
-
Represents a transaction, made by an
Account
. - EconomyTransaction(String, EconomyTransactionInitiator<?>, Temporal, EconomyTransactionType, String, BigDecimal, EconomyTransactionImportance) - Constructor for class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Creates a new account transaction object.
- EconomyTransaction.Builder - Class in me.lokka30.treasury.api.economy.transaction
-
Represents a builder of
EconomyTransaction
- EconomyTransactionImportance - Enum in me.lokka30.treasury.api.economy.transaction
-
Allocates a certain 'importance' to a
EconomyTransaction
, which could be useful information for the economy provider and consumers which process the transaction. - EconomyTransactionInitiator<T> - Interface in me.lokka30.treasury.api.economy.transaction
-
Represents an initiator of
EconomyTransaction
. - EconomyTransactionInitiator.Type - Enum in me.lokka30.treasury.api.economy.transaction
-
Represents a
EconomyTransactionInitiator
type. - EconomyTransactionType - Enum in me.lokka30.treasury.api.economy.transaction
-
Denotes which type of transaction occured in a
EconomyTransaction
. - EventBus - Enum in me.lokka30.treasury.api.common.event
-
Represents an event bus.
- EventBus.EventSubscriberBuilder<T> - Class in me.lokka30.treasury.api.common.event
-
Represents a builder of a
EventSubscriber
- eventClass() - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Returns the event class this subscriber has a subscription to.
- EventPriority - Enum in me.lokka30.treasury.api.common.event
-
Represents a priority of an
EventSubscriber
. - EventSubscriber<T> - Class in me.lokka30.treasury.api.common.event
-
Represents a subscriber of an event.
- EventSubscriber(Class<T>) - Constructor for class me.lokka30.treasury.api.common.event.EventSubscriber
- EventSubscriber(Class<T>, boolean) - Constructor for class me.lokka30.treasury.api.common.event.EventSubscriber
- EventSubscriber(Class<T>, EventPriority) - Constructor for class me.lokka30.treasury.api.common.event.EventSubscriber
- EventSubscriber(Class<T>, EventPriority, boolean) - Constructor for class me.lokka30.treasury.api.common.event.EventSubscriber
F
- fail(E) - Method in interface me.lokka30.treasury.api.common.response.Subscriber
-
Respond to the subscriber with an invocation failure.
- FailureReason - Interface in me.lokka30.treasury.api.common.response
-
A class that represents a description for a fail-case scenario when an action is attempted.
- FALSE - Enum constant in enum me.lokka30.treasury.api.common.misc.TriState
- FEATURE_NOT_SUPPORTED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to a
OptionalEconomyApiFeature
being attempted to be used, but it is not supported by the economy provider. - findCurrency(String) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Used to find a currency based on a specific identifier.
- fire(T) - Method in enum me.lokka30.treasury.api.common.event.EventBus
-
Calls/Fires the
EventSubscribers
of the specifiedevent
- FireCompletion<T> - Class in me.lokka30.treasury.api.common.event
-
Represents a
Completion
which is used when an event is fired. - FireCompletion(Class<?>) - Constructor for class me.lokka30.treasury.api.common.event.FireCompletion
- format(BigDecimal, Locale) - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Used to translate an amount to a user readable format with the default precision.
- format(BigDecimal, Locale, int) - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Used to translate an amount to a user readable format with the specified amount of decimal places.
- fromBoolean(Boolean) - Static method in enum me.lokka30.treasury.api.common.misc.TriState
- functional(Class<T>, EventPriority, boolean, Consumer<T>) - Static method in class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
-
Creates a new
SimpleEventSubscriber
via aConsumer
function. - functional(Class<T>, EventPriority, boolean, Function<T, Completion>) - Static method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Creates a new
EventSubscriber
via aFunction
- functional(Class<T>, EventPriority, Consumer<T>) - Static method in class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
-
Creates a new
SimpleEventSubscriber
via aConsumer
function. - functional(Class<T>, EventPriority, Function<T, Completion>) - Static method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Creates a new
EventSubscriber
via aFunction
- FutureHelper - Class in me.lokka30.treasury.api.common.misc
-
A utility class to help with
CompletableFuture
stuff - FutureHelper() - Constructor for class me.lokka30.treasury.api.common.misc.FutureHelper
G
- get() - Method in class me.lokka30.treasury.api.common.service.Service
-
Returns the held service.
- getAccount() - Method in class me.lokka30.treasury.api.economy.events.AccountTransactionEvent
-
Returns the
Account
for this account event. - getAccount() - Method in class me.lokka30.treasury.api.economy.events.NonPlayerAccountTransactionEvent
-
Returns the
Account
for this account event. - getAccount() - Method in class me.lokka30.treasury.api.economy.events.PlayerAccountTransactionEvent
-
Returns the
Account
for this account event. - getCurrencies() - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Used to get a set of every
Currency
object for the server. - getCurrencyID() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the
Currency
'sidentifier
with which the transaction was made. - getCurrentAPIVersion() - Static method in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.internal use only
- getData() - Method in interface me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator
-
Get the data, held in this
EconomyTransactionInitiator
- getDecimal() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Get's the currency's decimal character to be used for formatting purposes.
- getDescription() - Method in interface me.lokka30.treasury.api.common.response.FailureReason
-
Gets the description behind this
fail case
. - getDisplayNamePlural() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the plural form of the currency's user-friendly display name.
- getDisplayNameSingular() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the singular form of the currency's user-friendly display name.
- getErrors() - Method in class me.lokka30.treasury.api.common.event.Completion
-
Returns the errors this
Completion
got completed with. - getIdentifier() - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Gets the string-based unique identifier for this account.
- getIdentifier() - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Gets the string-based unique identifier for this account.
- getIdentifier() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the unique non-user friendly identifier for the currency.
- getImportance() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the importance of the transaction.
- getInitiator() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the
EconomyTransactionInitiator
of thisEconomyTransaction
- getMajorRevision() - Method in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.Returns the major api version as a short value for this
EconomyAPIVersion
- getMessage() - Method in exception me.lokka30.treasury.api.common.response.TreasuryException
-
Get a more detailed description of the reason for failure.
- getMinorRevision() - Method in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.Returns the minor api version as a short value for this
EconomyAPIVersion
- getName() - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Returns the name of this
Account
, if specified. - getPrecision() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the currency's default number of decimal digits when formatting this currency.
- getPrimaryCurrency() - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Get the primary or main
Currency
of the economy. - getPrimaryCurrencyId() - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Get the String identifier of the primary or main
Currency
of the economy. - getReason() - Method in exception me.lokka30.treasury.api.common.response.TreasuryException
-
Get a
FailureReason
representing why the failure occurred. - getReason() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the reason message of why this transaction happened.
- getService() - Method in class me.lokka30.treasury.api.common.service.event.ServiceRegisteredEvent
-
Returns the
Service
which has been registered - getService() - Method in class me.lokka30.treasury.api.common.service.event.ServiceUnregisteredEvent
-
Returns the
Service
which has been unregistered. - getStartingBalance(UUID) - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the starting balance of a specific player account for this currency.
- getSupportedAPIVersion() - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Deprecated.API versions are no longer used as of Treasury v1.1.0.
- getSupportedOptionalEconomyApiFeatures() - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Check which optional Treasury Economy API features the Economy Provider supports.
- getSymbol() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Gets the currency's symbol.
- getTimestamp() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the time at which this
Transaction
was made. - getTransaction() - Method in class me.lokka30.treasury.api.economy.events.AccountTransactionEvent
-
Returns the
EconomyTransaction
theAccountTransactionEvent.getAccount()
is doing. - getTransactionAmount() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Get the transaction amount.
- getTransactionType() - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Returns the transaction type.
- getType() - Method in interface me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator
-
Get the
EconomyTransactionInitiator.Type
for thisEconomyTransactionInitiator
- getUniqueId() - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Get the
UUID
of theAccount
.
H
- hasAccount(String, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request whether an identifier has an associated
Account
. - hasPermission(UUID, EconomySubscriber<TriState>, AccountPermission...) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Checks whether given player has the given permission on this account.
- hasPermission(UUID, EconomySubscriber<TriState>, AccountPermission...) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Checks whether given player has the given permission on this account.
- hasPlayerAccount(UUID, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request whether a user has an associated
PlayerAccount
. - hasRegistration(Class<?>) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Returns whether the specified service class has a registration.
- HIGH - Enum constant in enum me.lokka30.treasury.api.common.event.EventPriority
-
Event call is of high importance and must have one of the final says in what happens to the event.
- HIGH - Enum constant in enum me.lokka30.treasury.api.common.service.ServicePriority
- HIGH - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionImportance
-
The associated
EconomyTransaction
is of high importance.
I
- ignoreCancelled() - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Returns whether this subscriber is ignoring already cancelled events or not.
- ignoreCancelled(boolean) - Method in class me.lokka30.treasury.api.common.event.EventBus.EventSubscriberBuilder
-
Specifies whether the currently building
EventSubscriber
shall accept already cancelled events. - INSTANCE - Enum constant in enum me.lokka30.treasury.api.common.event.EventBus
- INSTANCE - Enum constant in enum me.lokka30.treasury.api.common.service.ServiceRegistry
- isCancelled() - Method in interface me.lokka30.treasury.api.common.event.Cancellable
-
Gets the cancellation state of this event.
- isCancelled() - Method in class me.lokka30.treasury.api.economy.events.AccountTransactionEvent
-
Gets the cancellation state of this event.
- isCompleted() - Method in class me.lokka30.treasury.api.common.event.Completion
-
Returns whether this
Completion
is completed. - isMember(UUID, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Check if the specified user is a member of the account.
- isMember(UUID, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Check if the specified user is a member of the account.
- isPrimary() - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Checks if this currency is the primary currency to use.
J
- join(Completion...) - Static method in class me.lokka30.treasury.api.common.event.Completion
-
Returns a
Completion
which is a summary from all the specifiedCompletions
other
. - joinAndFilter(Function<T, CompletableFuture<Boolean>>, Collection<CompletableFuture<T>>) - Static method in class me.lokka30.treasury.api.common.misc.FutureHelper
-
Does exactly what
FutureHelper.mapJoinFilter(Function, Function, Collection)
does except that it doesn't map data types.
L
- LOW - Enum constant in enum me.lokka30.treasury.api.common.event.EventPriority
-
Event call is of low importance and should be ran first, to allow other subscribers to further customise the outcome.
- LOW - Enum constant in enum me.lokka30.treasury.api.common.service.ServicePriority
- LOW - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionImportance
-
The associated
EconomyTransaction
is of low importance.
M
- mapJoinFilter(Function<A, CompletableFuture<Boolean>>, Function<A, B>, Collection<CompletableFuture<A>>) - Static method in class me.lokka30.treasury.api.common.misc.FutureHelper
-
Maps, joins, and filters futures.
- me.lokka30.treasury.api.common - package me.lokka30.treasury.api.common
-
Holds API classes that are meant to be utilized across multiple APIs.
- me.lokka30.treasury.api.common.event - package me.lokka30.treasury.api.common.event
-
Holds Treasury's event handler.
- me.lokka30.treasury.api.common.misc - package me.lokka30.treasury.api.common.misc
-
Holds classes which are not of a very high importance, but are still important.
- me.lokka30.treasury.api.common.response - package me.lokka30.treasury.api.common.response
-
Holds classes which are fundamental for Treasury's response system.
- me.lokka30.treasury.api.common.service - package me.lokka30.treasury.api.common.service
-
Holds classes that facilitate the registration of services in Treasury.
- me.lokka30.treasury.api.common.service.event - package me.lokka30.treasury.api.common.service.event
-
Holds various service events.
- me.lokka30.treasury.api.economy - package me.lokka30.treasury.api.economy
-
Holds Treasury's economy API.
- me.lokka30.treasury.api.economy.account - package me.lokka30.treasury.api.economy.account
-
Holds accounts and account related classes.
- me.lokka30.treasury.api.economy.currency - package me.lokka30.treasury.api.economy.currency
-
Holds classes which are directly connected with currencies.
- me.lokka30.treasury.api.economy.events - package me.lokka30.treasury.api.economy.events
-
Holds economy related events e.g.
- me.lokka30.treasury.api.economy.misc - package me.lokka30.treasury.api.economy.misc
-
Holds classes which are specific to Treasury's economy API but do not fall under other categories.
- me.lokka30.treasury.api.economy.response - package me.lokka30.treasury.api.economy.response
-
Holds economy related response classes.
- me.lokka30.treasury.api.economy.transaction - package me.lokka30.treasury.api.economy.transaction
-
Holds classes for the fundamental transaction system Treasury economy API provides.
- MIGRATION - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to an operation being cancelled due to economy migration being in progress.
- MODIFY_PERMISSIONS - Enum constant in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Allows a player to modify the permissions of other players on a
Account
N
- NEGATIVE_AMOUNT_SPECIFIED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to a negative amount being provided to a method that only accepts positive numbers.
- NEGATIVE_BALANCES - Enum constant in enum me.lokka30.treasury.api.economy.misc.OptionalEconomyApiFeature
-
Represents that the Economy Provider supports managing balances of all accounts with negative (below-zero) balances.
- NEGATIVE_BALANCES_NOT_SUPPORTED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to an overdraft when negative balances are not supported.
- newBuilder() - Static method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction
-
Creates a new
EconomyTransaction.Builder
- NonPlayerAccount - Interface in me.lokka30.treasury.api.economy.account
-
This is used to differentiate between a
player account
and anaccount
that is not associated with a player. - NonPlayerAccountTransactionEvent - Class in me.lokka30.treasury.api.economy.events
-
Represents an event, called when a
NonPlayerAccount
does aEconomyTransaction
- NonPlayerAccountTransactionEvent(EconomyTransaction, NonPlayerAccount) - Constructor for class me.lokka30.treasury.api.economy.events.NonPlayerAccountTransactionEvent
- NORMAL - Enum constant in enum me.lokka30.treasury.api.common.event.EventPriority
-
Event call is neither important nor unimportant, and may be ran normally.
- NORMAL - Enum constant in enum me.lokka30.treasury.api.common.service.ServicePriority
- NORMAL - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionImportance
-
The associated
EconomyTransaction
is of normal importance. - NULL_PARAMETER - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to a null parameter being specified when a null parameter was not expected.
- NUMBER_PARSING_ERROR - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to a String not following an expected format/pattern when attempting to parse it into a number type such as
BigDecimal
.
O
- of(String) - Static method in interface me.lokka30.treasury.api.common.response.FailureReason
-
Creates a new
FailureReason
with the specifieddescription
- onEvent(T) - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Treasury's
EventBus
calls this method whenever aEventBus.fire(Object)
occurs with the event this subscription listens for. - onEvent(T) - Method in class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
-
Treasury's
EventBus
calls this method whenever aEventBus.fire(Object)
occurs with the event this subscription listens for. - OptionalEconomyApiFeature - Enum in me.lokka30.treasury.api.economy.misc
-
Economy Providers may support these specific features at their own option.
- OTHER_FAILURE - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
Use this constant if the method resulted in a complete failure, AND no other constant in this enum is applicable to the issue that occurred.
P
- parse(String, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Used to get the BigDecimal representation of an amount represented by a formatted string.
- PLAYER - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator.Type
- PLAYER_ACCOUNT_PERMISSION_MODIFICATION_NOT_SUPPORTED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure whenever the default implementation of
PlayerAccount.setPermission(UUID, TriState, EconomySubscriber, AccountPermission...)
has been called. - PlayerAccount - Interface in me.lokka30.treasury.api.economy.account
-
A PlayerAccount is an Account owned by a Player.
- PlayerAccountTransactionEvent - Class in me.lokka30.treasury.api.economy.events
-
Represents an event, called when a
PlayerAccount
does aEconomyTransaction
- PlayerAccountTransactionEvent(EconomyTransaction, PlayerAccount) - Constructor for class me.lokka30.treasury.api.economy.events.PlayerAccountTransactionEvent
- PLUGIN - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator.Type
- priority() - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
-
Returns the
EventPriority
of this subscriber. - priority() - Method in class me.lokka30.treasury.api.common.service.Service
-
Returns the
ServicePriority
at which this service was registered.
R
- registerCurrency(Currency, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Used to register a currency with the
EconomyProvider
to be utilized by other plugins. - registerService(Class<T>, T, String, ServicePriority) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Register a provider of a service.
- registrarName() - Method in class me.lokka30.treasury.api.common.service.Service
-
Returns a
String
identifier of who registered this service. - REQUEST_CANCELLED - Enum constant in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
A constant representing failure due to request cancellation.
- resetBalance(EconomyTransactionInitiator<?>, Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Reset the
Account
balance to its starting amount. - resetBalance(EconomyTransactionInitiator<?>, Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Resets the player's balance.
- retrieveAccount(String, EconomySubscriber<Account>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request an existing
Account
for a specific identifier. - retrieveAccountIds(EconomySubscriber<Collection<String>>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request all identifiers with associated
Accounts
. - retrieveAllAccountsPlayerHasPermission(UUID, EconomySubscriber<Collection<String>>, AccountPermission...) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request all the
non-player accounts
where the given player has the given permissions. - retrieveAllAccountsPlayerIsMemberOf(UUID, EconomySubscriber<Collection<String>>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request all
non player accounts
the given player is a member of. - retrieveBalance(Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Request the balance of the
Account
. - retrieveHeldCurrencies(EconomySubscriber<Collection<String>>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Returns the
Currencies
thisAccount
holds balance for. - retrieveMemberIds(EconomySubscriber<Collection<UUID>>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Request a listing of all member players of the account.
- retrieveMemberIds(EconomySubscriber<Collection<UUID>>) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Request a listing of all member players of the account.
- retrieveNonPlayerAccountIds(EconomySubscriber<Collection<String>>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request all identifiers with associated
NonPlayer Accounts
. - retrievePermissions(UUID, EconomySubscriber<Map<AccountPermission, TriState>>) - Method in interface me.lokka30.treasury.api.economy.account.Account
- retrievePermissions(UUID, EconomySubscriber<Map<AccountPermission, TriState>>) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
- retrievePlayerAccount(UUID, EconomySubscriber<PlayerAccount>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request an existing
PlayerAccount
for a user. - retrievePlayerAccountIds(EconomySubscriber<Collection<UUID>>) - Method in interface me.lokka30.treasury.api.economy.EconomyProvider
-
Request all
UUIDs
with associatedPlayerAccounts
. - retrieveTransactionHistory(int, Temporal, Temporal, EconomySubscriber<Collection<EconomyTransaction>>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Request the
EconomyTransaction
history, limited by thetransactionCount
and theTemporal
from
andTemporal
to
, of thisAccount
. - retrieveTransactionHistory(int, EconomySubscriber<Collection<EconomyTransaction>>) - Method in interface me.lokka30.treasury.api.economy.account.Account
S
- SERVER - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator.Type
- SERVER - Static variable in interface me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator
-
Returns an
EconomyTransactionInitiator
withEconomyTransactionInitiator.Type.SERVER
type. - Service<T> - Class in me.lokka30.treasury.api.common.service
-
Represents a service.
- Service(String, ServicePriority, T) - Constructor for class me.lokka30.treasury.api.common.service.Service
- serviceFor(Class<T>) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Queries for a service with the specified
Class
. - ServicePriority - Enum in me.lokka30.treasury.api.common.service
-
Represents a priority of a service.
- ServiceRegisteredEvent - Class in me.lokka30.treasury.api.common.service.event
-
An event, called whenever a
Service
has been registered - ServiceRegisteredEvent(Service<?>) - Constructor for class me.lokka30.treasury.api.common.service.event.ServiceRegisteredEvent
- ServiceRegistry - Enum in me.lokka30.treasury.api.common.service
-
Represents the place where
services
are registered and unregistered. - ServiceUnregisteredEvent - Class in me.lokka30.treasury.api.common.service.event
-
An event, called whenever a
Service
has been unregistered - ServiceUnregisteredEvent(Service<?>) - Constructor for class me.lokka30.treasury.api.common.service.event.ServiceUnregisteredEvent
- setBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Set the balance of the
Account
. - setCancelled(boolean) - Method in interface me.lokka30.treasury.api.common.event.Cancellable
-
Sets the cancellation state of this event.
- setCancelled(boolean) - Method in class me.lokka30.treasury.api.economy.events.AccountTransactionEvent
-
Sets the cancellation state of this event.
- setName(String, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Sets a new name for this
Account
, which may be null. - setName(String, EconomySubscriber<Boolean>) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
-
Sets a new name for this
Account
, which may be null. - setPermission(UUID, TriState, EconomySubscriber<TriState>, AccountPermission...) - Method in interface me.lokka30.treasury.api.economy.account.Account
- setPermission(UUID, TriState, EconomySubscriber<TriState>, AccountPermission...) - Method in interface me.lokka30.treasury.api.economy.account.PlayerAccount
- SimpleEventSubscriber<T> - Class in me.lokka30.treasury.api.common.event
-
Represents a simple event subscriber.
- SimpleEventSubscriber(Class<T>) - Constructor for class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
- SimpleEventSubscriber(Class<T>, boolean) - Constructor for class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
- SimpleEventSubscriber(Class<T>, EventPriority) - Constructor for class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
- SimpleEventSubscriber(Class<T>, EventPriority, boolean) - Constructor for class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
- SortedList<T extends Comparable<T>> - Class in me.lokka30.treasury.api.common.misc
-
Represents a sorted list.
- SortedList() - Constructor for class me.lokka30.treasury.api.common.misc.SortedList
- subscribe(EventSubscriber<T>) - Method in enum me.lokka30.treasury.api.common.event.EventBus
-
Subscribes this
EventSubscriber
for calling whenever the event the specifiedsubscription
is listening for gets fired. - subscribe(T) - Method in class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
-
Treasury's
EventBus
calls this method whenever aEventBus.fire(Object)
occurs with the event this subscription listens for. - Subscriber<T,
E extends TreasuryException> - Interface in me.lokka30.treasury.api.common.response -
An interface accepting responses from a provider.
- subscriptionFor(Class<T>) - Method in enum me.lokka30.treasury.api.common.event.EventBus
-
Creates a
EventBus.EventSubscriberBuilder
for the specifiedeventClass
- succeed(T) - Method in interface me.lokka30.treasury.api.common.response.Subscriber
-
Respond to the subscriber with a successful invocation.
T
- to(Currency, BigDecimal, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.currency.Currency
-
Used to convert this
Currency
to another based on a specified amount of the other currency. - toString() - Method in class me.lokka30.treasury.api.common.event.EventSubscriber
- toString() - Method in class me.lokka30.treasury.api.common.event.SimpleEventSubscriber
- toString() - Method in class me.lokka30.treasury.api.common.service.Service
- TRANSACTION_EVENTS - Enum constant in enum me.lokka30.treasury.api.economy.misc.OptionalEconomyApiFeature
-
Represents that the Economy Provider calls Treasury's AccountTransaction events when transactions occur.
- TreasuryException - Exception in me.lokka30.treasury.api.common.response
-
The base class for exceptions thrown in Treasury's APIs, such as the
EconomyException
. - TreasuryException(FailureReason) - Constructor for exception me.lokka30.treasury.api.common.response.TreasuryException
-
Construct a new
TreasuryException
. - TreasuryException(FailureReason, String) - Constructor for exception me.lokka30.treasury.api.common.response.TreasuryException
-
Construct a new
TreasuryException
. - TreasuryException(FailureReason, String, Throwable) - Constructor for exception me.lokka30.treasury.api.common.response.TreasuryException
-
Construct a new
EconomyException
. - TreasuryException(FailureReason, Throwable) - Constructor for exception me.lokka30.treasury.api.common.response.TreasuryException
-
Construct a new
TreasuryException
. - TriState - Enum in me.lokka30.treasury.api.common.misc
-
Represents an enum, containing 3 enum values, representing states, hence the name "TriState".
- TRUE - Enum constant in enum me.lokka30.treasury.api.common.misc.TriState
U
- unregister(Class<?>, Object) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Unregister a particular service.
- unregisterAll(String) - Method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Unregister all services from a particular registrar.
- UNSPECIFIED - Enum constant in enum me.lokka30.treasury.api.common.misc.TriState
V
- v1_0 - Enum constant in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.
- V1_1 - Enum constant in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.common.event.EventBus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.common.event.EventPriority
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.common.misc.TriState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.common.service.ServicePriority
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.misc.OptionalEconomyApiFeature
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionImportance
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum me.lokka30.treasury.api.common.event.EventBus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.common.event.EventPriority
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.common.misc.TriState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.common.service.ServicePriority
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.common.service.ServiceRegistry
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.misc.EconomyAPIVersion
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.misc.OptionalEconomyApiFeature
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.response.EconomyFailureReason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionImportance
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionInitiator.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- waitCompletion() - Method in class me.lokka30.treasury.api.common.event.Completion
-
Waits for this
Completion
to complete. - waitCompletion() - Method in class me.lokka30.treasury.api.common.event.FireCompletion
-
Waits for this completion to complete and prints all the errors if this completion got completed exceptionally.
- whenCalled(Consumer<T>) - Method in class me.lokka30.treasury.api.common.event.EventBus.EventSubscriberBuilder
-
Specifies the action to do whenever the event the currently building
EventSubscriber
subscribes for gets fired. - whenCalled(Function<T, Completion>) - Method in class me.lokka30.treasury.api.common.event.EventBus.EventSubscriberBuilder
-
Specifies the action to do whenever the event the currently building
EventSubscriber
subscribes for gets fired with the ability to block event execution until an asynchronous task finishes. - whenComplete(Consumer<Collection<Throwable>>) - Method in class me.lokka30.treasury.api.common.event.Completion
- whenCompleteAsync(BiConsumer<T, Collection<Throwable>>) - Method in class me.lokka30.treasury.api.common.event.FireCompletion
-
Runs the specified
BiConsumer
task
asynchronously when this completion completes. - whenCompleteBlocking(BiConsumer<T, Collection<Throwable>>) - Method in class me.lokka30.treasury.api.common.event.FireCompletion
-
Runs the specified
BiConsumer
task when this completion completes. - withCurrency(Currency) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the
Currency
the transaction was made in. - withCurrencyId(String) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the
identifier
of aCurrency
the transaction was made in. - WITHDRAW - Enum constant in enum me.lokka30.treasury.api.economy.account.AccountPermission
-
Allows a player to withdraw from the
Account
. - WITHDRAWAL - Enum constant in enum me.lokka30.treasury.api.economy.transaction.EconomyTransactionType
-
The Account's new balance is less than their previous balance.
- withdrawBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Withdraw an amount from the
Account
balance. - withdrawBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomyTransactionImportance, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Withdraw an amount from the
Account
balance. - withdrawBalance(BigDecimal, EconomyTransactionInitiator<?>, Currency, EconomyTransactionImportance, String, EconomySubscriber<BigDecimal>) - Method in interface me.lokka30.treasury.api.economy.account.Account
-
Withdraw an amount from the
Account
balance. - withImportance(EconomyTransactionImportance) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the importance this transaction should have.
- withInitiator(EconomyTransactionInitiator<?>) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the
EconomyTransactionInitiator
the transaction got triggered by. - withPriority(EventPriority) - Method in class me.lokka30.treasury.api.common.event.EventBus.EventSubscriberBuilder
-
Specifies the
EventPriority
of the currently buildingEventSubscriber
- withReason(String) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify a reason for this transaction.
- withTimestamp(Temporal) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the time when the transaction got triggered.
- withTransactionAmount(BigDecimal) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the amount this transaction is going to either
EconomyTransactionType.WITHDRAWAL
orEconomyTransactionType.DEPOSIT
- withTransactionType(EconomyTransactionType) - Method in class me.lokka30.treasury.api.economy.transaction.EconomyTransaction.Builder
-
Specify the
EconomyTransactionType
transactionType
of the transaction.
All Classes and Interfaces|All Packages|Serialized Form
OptionalEconomyApiFeature.TRANSACTION_EVENTS
instead