net.tridentsdk.server.service

Class TransactionHandler

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<Transaction>

net.tridentsdk.server.service.TransactionHandler

All Implemented Interfaces:

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

public class TransactionHandler
extends com.google.common.collect.ForwardingCollection<Transaction>
implements Transactions

Performs API transactions

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
TransactionHandler() Do not instantiate.

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
protected Collection<Transaction>	delegate()
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 class com.google.common.collect.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

TransactionHandler

public TransactionHandler()

Do not instantiate.

To access this handler, use this code:

     Transactions handler = Registered.transactions();
 

Method Detail

newAcount

public int newAcount()

Description copied from interface: Transactions

Creates a new account from the internal account clock

Specified by:

newAcount in interface Transactions

Returns:

the new account ID used in transactions

globalEconomy

public int globalEconomy()

Description copied from interface: Transactions

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.

Specified by:

globalEconomy in interface Transactions

Returns:

the global economy transaction ID

globalExchange

public int globalExchange()

Description copied from interface: Transactions

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.

Specified by:

globalExchange in interface Transactions

Returns:

the global exchange transaction ID

deposit

public void deposit(int account,
                    Transaction transaction)

Description copied from interface: Transactions

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

Specified by:

deposit in interface Transactions

Parameters:

account - the account ID to be used

transaction - the transaction to perform

withdraw

public boolean withdraw(int account,
                        Transaction transaction)

Description copied from interface: Transactions

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.

Specified by:

withdraw in interface Transactions

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

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

Description copied from interface: Transactions

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

Specified by:

amount in interface Transactions

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

delegate

protected Collection<Transaction> delegate()

Overrides:

delegate in class com.google.common.collect.ForwardingCollection<Transaction>