Skip to content

Update javadocs for withdraw and deposit. #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
creatorfromhell merged 2 commits into from
Aug 13, 2026
Merged

Update javadocs for withdraw and deposit. #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac87f45
Update javadocs for withdraw and deposit.
creatorfromhell Aug 13, 2026
5435b58
Rename implementations -> callers
creatorfromhell Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/main/java/net/milkbowl/vault2/economy/Economy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -924,6 +924,9 @@ default EconomyResponse canWithdraw(@NotNull final String pluginName, @NotNull f
* <br>
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canWithdraw(String, UUID, BigDecimal)} first where implemented.
* As callers may or may not do checks in the withdraw method as a backup verification.
* </p>
* @param pluginName The name of the plugin that is calling the method.
* @param accountID the UUID associated with the account to withdraw from.
Expand All @@ -945,6 +948,9 @@ default EconomyResponse canWithdraw(@NotNull final String pluginName, @NotNull f
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canWithdraw(String, UUID, String, BigDecimal)} first where implemented.
* As callers may or may not do checks in the withdraw method as a backup verification.
* <br>
* If the provider does not support multiple worlds, the provider's default world will be used.
* </p>
* @param pluginName The name of the plugin that is calling the method.
Expand All @@ -968,6 +974,9 @@ default EconomyResponse canWithdraw(@NotNull final String pluginName, @NotNull f
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canWithdraw(String, UUID, String, String, BigDecimal)} first where implemented.
* As callers may or may not do checks in the withdraw method as a backup verification.
* <br>
* If the provider does not support multiple worlds, the provider's default world will be used.
* <br>
* If the provider does not support multi-currency, the provider's default currency will be
Expand Down Expand Up @@ -1084,6 +1093,9 @@ default EconomyResponse canDeposit(@NotNull final String pluginName, @NotNull fi
* <br>
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canDeposit(String, UUID, BigDecimal)} first where implemented.
* As callers may or may not do checks in the deposit method as a backup verification.
* </p>
* @param pluginName The name of the plugin that is calling the method.
* @param accountID the UUID associated with the account to deposit to.
Expand All @@ -1105,6 +1117,9 @@ default EconomyResponse canDeposit(@NotNull final String pluginName, @NotNull fi
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canDeposit(String, UUID, String, BigDecimal)} first where implemented.
* As callers may or may not do checks in the deposit method as a backup verification.
* <br>
* If the provider does not support multiple worlds, the provider's default world will be used.
* </p>
* @param pluginName The name of the plugin that is calling the method.
Expand All @@ -1128,6 +1143,9 @@ default EconomyResponse canDeposit(@NotNull final String pluginName, @NotNull fi
* Note: {@code pluginName} should be used for logging/diagnostics only and MUST NOT affect
* business logic.
* <br>
* Note: Callers should perform checks against {@link #canDeposit(String, UUID, String, String, BigDecimal)} first where implemented.
* As callers may or may not do checks in the deposit method as a backup verification.
* <br>
* If the provider does not support multiple worlds, the provider's default world will be used.
* <br>
* If the provider does not support multi-currency, the provider's default currency will be
Expand Down
Loading