Package com.plotsquared.core.util

Class EconHandler

java.lang.Object

com.plotsquared.core.util.EconHandler

public abstract class EconHandler
extends Object

Constructor Summary

Constructors

Constructor	Description
EconHandler()

Method Summary

Modifier and Type	Method	Description
abstract void	depositMoney(OfflinePlotPlayer player, double amount)
abstract void	depositMoney(PlotPlayer<?> player, double amount)
abstract @NonNull String	format(double balance)	Formats the given balance into a human-readable number.
abstract double	getBalance(PlotPlayer<?> player)
double	getMoney(PlotPlayer<?> player)
abstract boolean	init()
abstract boolean	isEnabled(PlotArea plotArea)	Returns whether economy is enabled in the given plot area or not.
abstract boolean	isSupported()	Returns whether economy is supported by the server or not.
static EconHandler	nullEconHandler()	Returns an econ handler that: Returns false on isEnabled(PlotArea) Returns Double.MIN_VALUE on getBalance(PlotPlayer) Doesn't do anything for withdrawMoney(PlotPlayer, double), depositMoney(OfflinePlotPlayer, double) depositMoney(PlotPlayer, double)
abstract void	withdrawMoney(PlotPlayer<?> player, double amount)

Methods inherited from class java.lang.Object

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

Constructor Details

EconHandler

public EconHandler()

Method Details

nullEconHandler

public static EconHandler nullEconHandler()

Returns an econ handler that:

• Returns false on isEnabled(PlotArea)
• Returns Double.MIN_VALUE on getBalance(PlotPlayer)
• Doesn't do anything for withdrawMoney(PlotPlayer, double), depositMoney(OfflinePlotPlayer, double) depositMoney(PlotPlayer, double)

Returns:

A null econ handler

init

public abstract boolean init()

getMoney

public double getMoney(PlotPlayer<?> player)

getBalance

public abstract double getBalance(PlotPlayer<?> player)

withdrawMoney

public abstract void withdrawMoney(PlotPlayer<?> player,
 double amount)

depositMoney

public abstract void depositMoney(PlotPlayer<?> player,
 double amount)

depositMoney

public abstract void depositMoney(OfflinePlotPlayer player,
 double amount)

isEnabled

public abstract boolean isEnabled(PlotArea plotArea)

Returns whether economy is enabled in the given plot area or not. Implementations should only return true if isSupported() returns true too.

Parameters:

plotArea - the plot area to check

Returns:

true if economy is enabled on the given plot area, false otherwise.

format

public abstract @NonNull String format(double balance)

Formats the given balance into a human-readable number.

Parameters:

balance - the balance to format.

Returns:

the balance as formatted string.

isSupported

public abstract boolean isSupported()

Returns whether economy is supported by the server or not.

Returns:

true if economy is supported, false otherwise.