mirror of
https://github.com/MilkBowl/VaultAPI.git
synced 2024-09-27 14:53:01 +02:00
Splitted IdentityEconomy isLegacy method into supportsAllRecordsOperation and supportsAllOnlineOperation
Improved IdentityEconomy and MultiEconomy documentation
This commit is contained in:
parent
dfd74cea31
commit
5dc0217eb7
2
pom.xml
2
pom.xml
@ -3,7 +3,7 @@
|
|||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>net.milkbowl.vault</groupId>
|
<groupId>net.milkbowl.vault</groupId>
|
||||||
<artifactId>vaultapi</artifactId>
|
<artifactId>vaultapi</artifactId>
|
||||||
<version>2.4-SNAPSHOT</version>
|
<version>2.0-SNAPSHOT</version>
|
||||||
|
|
||||||
<name>VaultAPI</name>
|
<name>VaultAPI</name>
|
||||||
<description>Vault is a Permissions & Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves.
|
<description>Vault is a Permissions & Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves.
|
||||||
|
@ -25,9 +25,10 @@ import java.util.UUID;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds UUID support to the Economy interface.
|
* Adds UUID support to the Economy interface.
|
||||||
* In case of {@link #isLegacy()} returning false, methods such as:
|
* In case of {@link #supportsAllRecordsOperation()} or {@link #supportsAllOnlineOperation()}
|
||||||
|
* returning true, methods such as
|
||||||
* {@link #getAllRecords()} and {@link #getAllOnline()}
|
* {@link #getAllRecords()} and {@link #getAllOnline()}
|
||||||
* should be expected to work.
|
* should not be expected to work.
|
||||||
* <p>
|
* <p>
|
||||||
* In order to register/provide it, you should use {@link IdentityEconomyWrapper#registerProviders()}
|
* In order to register/provide it, you should use {@link IdentityEconomyWrapper#registerProviders()}
|
||||||
*/
|
*/
|
||||||
@ -35,15 +36,22 @@ public interface IdentityEconomy extends Economy{
|
|||||||
/**
|
/**
|
||||||
* Used to determine if IdentityEconomy was built through
|
* Used to determine if IdentityEconomy was built through
|
||||||
* the EconomyWrapper as a LegacyEconomy.
|
* the EconomyWrapper as a LegacyEconomy.
|
||||||
* If true, methods such as {@link #getAllRecords()} and {@link #getAllOnline()} (UUID)}
|
* If true, method {@link #getAllRecords()} will not be work.
|
||||||
* will not be work.
|
|
||||||
* This was made in order to support plugins which use older versions of VaultAPI/Vault.
|
* This was made in order to support plugins which use older versions of VaultAPI/Vault.
|
||||||
* You can also use it / override it to disable previous mentioned methods!
|
* You can also use it / override it to disable previous mentioned methods!
|
||||||
* @return if this is a legacy economy
|
* @return true if operation is supported
|
||||||
*/
|
*/
|
||||||
public default boolean isLegacy(){
|
public boolean supportsAllRecordsOperation();
|
||||||
return false;
|
|
||||||
}
|
/**
|
||||||
|
* Used to determine if IdentityEconomy was built through
|
||||||
|
* the EconomyWrapper as a LegacyEconomy.
|
||||||
|
* If true, the method {@link #getAllOnline()} (UUID)} will not be work.
|
||||||
|
* This was made in order to support plugins which use older versions of VaultAPI/Vault.
|
||||||
|
* You can also use it / override it to disable previous mentioned methods!
|
||||||
|
* @return true if operation is supported
|
||||||
|
*/
|
||||||
|
public boolean supportsAllOnlineOperation();
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Account-related methods follow.
|
* Account-related methods follow.
|
||||||
|
@ -14,8 +14,13 @@ public class LegacyEconomy implements IdentityEconomy {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean isLegacy() {
|
public boolean supportsAllRecordsOperation() {
|
||||||
return true;
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean supportsAllOnlineOperation() {
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -13,7 +13,8 @@ import java.util.Collection;
|
|||||||
* In order to register/provide it, you should use {@link MultiEconomyWrapper#registerProviders()}
|
* In order to register/provide it, you should use {@link MultiEconomyWrapper#registerProviders()}
|
||||||
* Inside this interface, we make use of the term "implementation" to refer to an actual currency.
|
* Inside this interface, we make use of the term "implementation" to refer to an actual currency.
|
||||||
* You should expect that these currencies/implementations might
|
* You should expect that these currencies/implementations might
|
||||||
* return true for {@link IdentityEconomy#isLegacy()} in case plugin's author preference!
|
* return false for both {@link IdentityEconomy#supportsAllRecordsOperation()} and
|
||||||
|
* {@link IdentityEconomy#supportsAllOnlineOperation()} in case of plugin's author preference!
|
||||||
*/
|
*/
|
||||||
public interface MultiEconomy {
|
public interface MultiEconomy {
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user