net.tridentsdk.service

Interface Transactions

All Superinterfaces:

Collection<Transaction>, Iterable<Transaction>, Registry<Transaction>

All Known Implementing Classes:

TransactionHandler

@ThreadSafe
public interface Transactions
extends Registry<Transaction>

Handles player transactions, such objects, items, and currency

This is designed around multiple accounts which are not really accounts, but really a system of synchronizing transactions of a particular type. One account, for example, can be used for economy by one plugin, but that can interfere with another plugin's economy. A new account can be made supporting the same types used in the other plugin without interfering. Additionally, this has the advantage of being able to easily access another plugin's economy data, useful for providing hooks.

Example:

     // Economy
     private static final Transactions handler = Registered.transactions();

     // This must be static! Or you would end up with many different transactions
     // to the wrong account
     private static final int ECON_ID = handler.newAccount();

     // Deposit
     handler.deposit(ECON_ID, new Transaction<Player, Player>(int.class, playerFrom, playerTo, 100) {
         @Override public void doTransaction(Type type) {
             // If check is not required but is a good debugging safeguard
             if (type == Type.DEPOSIT) {
                 receiver().sendMessage(sender().name() + " has sent you $" + amount());
                 // You may give items here as well
             }
         }
     });

     // Remove
     handler.withdraw(ECON_ID, new Transaction<Player, Player>(int.class, playerTo, playerTo, 100) {
         @Override public void doTransaction(Type type) {
             // If check is not required but is a good debugging safeguard
             if (type == Type.WITHDRAW) {
                 sender().sendMessage("You have withdrawn $" + amount());
                 // You may give items here as well
             }
         }
     });

     // Amount
     int amount = handler.amount(ECON_ID, playerTo, int.class);
 

This class also contains global account IDs for economy and exchange [of items].

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
int	amount(int account, Object person, Object type) Obtains the amount of an item as indicated by the amount field in each transaction
void	deposit(int account, Transaction transaction) Performs a transaction from the transaction's sender to the transaction's receiver
int	globalEconomy() The global economy ID to be used as the transaction ID
int	globalExchange() The global exchange ID to be used as the transaction ID
int	newAcount() Creates a new account from the internal account clock
boolean	withdraw(int account, Transaction transaction) Withdraws an item from the account

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

newAcount

int newAcount()

Creates a new account from the internal account clock

Returns:

the new account ID used in transactions

globalEconomy

int globalEconomy()

The global economy ID to be used as the transaction ID

This is just a recommendation to use for plugins. You do not need to use this.

Returns:

the global economy transaction ID

globalExchange

int globalExchange()

The global exchange ID to be used as the transaction ID

This is just a recommendation to use for plugins. You do not need to use this.

Returns:

the global exchange transaction ID

deposit

void deposit(int account,
             Transaction transaction)

Performs a transaction from the transaction's sender to the transaction's receiver

Parameters:

account - the account ID to be used

transaction - the transaction to perform

withdraw

boolean withdraw(int account,
                 Transaction transaction)

Withdraws an item from the account

IMPORTANT: The sender is the person withdrawing from the account. The receiver is not taken into consideration, so that is allowed to be null.

Parameters:

account - the account ID to be used

transaction - the transaction to perform

Returns:

false if the account for the withdrawer does not exist, true if the transaction completes successfully

amount

int amount(int account,
           Object person,
           Object type)

Obtains the amount of an item as indicated by the amount field in each transaction

Parameters:

account - the account ID to be used

person - the object which the transactions were sent to that is checked by this amounting

type - the types to find the amount of. Also the parameter in Transaction.item()

Returns:

the amount of an item of type type found the account of person, or Integer.MIN_VALUE if the account for person does not exist, or the accound ID is not used for that person