-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement TeamMember as a subinterface of OnlineUser (#267)
- Loading branch information
1 parent
fe6a2d6
commit 20c65e9
Showing
6 changed files
with
217 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
src/main/java/minevalley/core/api/users/TeamMember.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| package minevalley.core.api.users; | ||
|
|
||
| import minevalley.core.api.users.enums.TeamRank; | ||
| import org.jetbrains.annotations.Contract; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| public interface TeamMember extends OnlineUser { | ||
|
|
||
| /** | ||
| * Gets whether the player is team-member with the plus-rank. | ||
| * | ||
| * @return true, if the user is team-plus-member | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isTeamPlus(); | ||
|
|
||
| /** | ||
| * Gets the team-rank of this user. | ||
| * | ||
| * @return users team-rank | ||
| */ | ||
| @Nonnull | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| TeamRank getTeamRank(); | ||
|
|
||
| /** | ||
| * Gets the custom team rank name. | ||
| * If no custom name is defined, this returns the name of the users team rank. | ||
| * | ||
| * @return [custom] team rank name | ||
| */ | ||
| @Nullable | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| String getCustomTeamRankName(); | ||
|
|
||
| /** | ||
| * Sometimes a player is assigned a team rank to grant them permission or access. | ||
| * Because team members are highlighted in the chat and tab list, | ||
| * they appear representative of the project and players may assume they have the permission and knowledge | ||
| * to guide other players. Therefore, the rank assigned to the player can be hidden. | ||
| * | ||
| * @return true, if this user is displayed as team member in chat, tab list, etc. | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isDisplayedAsTeamler(); | ||
|
|
||
| /** | ||
| * Gets whether the user has any of the listed team-ranks. | ||
| * | ||
| * @param ranks list of team-ranks to be checked for | ||
| * @return true, if the user has one of the ranks | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean hasTeamRank(@Nonnull TeamRank... ranks); | ||
|
|
||
| /** | ||
| * Gets whether the user is allowed to use a general-key | ||
| * | ||
| * @return true, if the player is allowed to use a general-key | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isAllowedToUseGeneralKey(); | ||
|
|
||
| /** | ||
| * Gets whether the user is using a general-key at the moment, by checking the item in his hand. If he is using a general-key without the permission to do, his key gets removed automatically. | ||
| * | ||
| * @return true, if the player is using a general-key | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isUsingGeneralKey(); | ||
|
|
||
| /** | ||
| * Lets the user leave the team-service. | ||
| */ | ||
| @SuppressWarnings("removal") | ||
| void leaveTeamService() throws IllegalStateException; | ||
|
|
||
| /** | ||
| * Gets whether the user is allowed to enter the support-service. | ||
| * | ||
| * @return true, if the user is allowed to enter the support-service | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean canEnterSupportService(); | ||
|
|
||
| /** | ||
| * Lets the user enter the support-service. If the user isn't allowed to, nothing happens. | ||
| */ | ||
| @SuppressWarnings("removal") | ||
| void joinSupportService() throws UnsupportedOperationException, IllegalStateException; | ||
|
|
||
| /** | ||
| * Lets the user leave the support-service. | ||
| */ | ||
| @SuppressWarnings("removal") | ||
| void leaveSupportService() throws IllegalStateException; | ||
|
|
||
| /** | ||
| * Gets whether the user is marked as server-operator (!= OP-permission) | ||
| * | ||
| * @return true, if the user is marked as server-operator | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isOperator(); | ||
|
|
||
| /** | ||
| * Gets whether the user is in support-service | ||
| * | ||
| * @return true, if the user is in support-service | ||
| */ | ||
| @Contract(pure = true) | ||
| @SuppressWarnings("removal") | ||
| boolean isInSupportService(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
src/main/java/minevalley/core/api/users/exceptions/UserNotOnlineException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package minevalley.core.api.users.exceptions; | ||
|
|
||
| import lombok.Getter; | ||
| import minevalley.core.api.users.User; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
|
|
||
| @Getter | ||
| public class UserNotOnlineException extends RuntimeException { | ||
|
|
||
| private final User user; | ||
|
|
||
| public UserNotOnlineException(@Nonnull User user) { | ||
| super("User " + user.getName() + " is not online."); | ||
| this.user = user; | ||
| } | ||
| } |
22 changes: 22 additions & 0 deletions
22
src/main/java/minevalley/core/api/users/exceptions/UserNotPermittedException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package minevalley.core.api.users.exceptions; | ||
|
|
||
| import lombok.Getter; | ||
| import minevalley.core.api.users.User; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
|
|
||
| @Getter | ||
| public class UserNotPermittedException extends RuntimeException { | ||
|
|
||
| private final User user; | ||
|
|
||
| public UserNotPermittedException(@Nonnull User user) { | ||
| super("User " + user.getName() + " is not permitted to perform this action."); | ||
| this.user = user; | ||
| } | ||
|
|
||
| public UserNotPermittedException(@Nonnull User user, @Nonnull String message) { | ||
| super(message); | ||
| this.user = user; | ||
| } | ||
| } |