Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
Merge pull request #4 from Andre601/feature/v3.1.0
Browse files Browse the repository at this point in the history 
v3.1.0: Add maxPlayers option
  • Loading branch information
@Andre601
Andre601 authored Sep 19, 2023
2 parents 7d0b6c1 + e346b51 commit 873d949
Showing 1 changed file with 95 additions and 5 deletions.
100 changes: 95 additions & 5 deletions api/src/main/java/ch/andre601/advancedserverlist/api/profiles/ProfileEntry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
* of this class added.
*/
public record ProfileEntry(List<String> motd, List<String> players, String playerCountText, String favicon,
NullBool hidePlayersEnabled, NullBool extraPlayersEnabled, Integer extraPlayersCount){
NullBool hidePlayersEnabled, NullBool extraPlayersEnabled, NullBool maxPlayersEnabled,
Integer extraPlayersCount, Integer maxPlayersCount){

/**
* Creates a new instance of a ProfileEntry with the given values.
Expand All @@ -58,8 +59,12 @@ public record ProfileEntry(List<String> motd, List<String> players, String playe
* Whether player count should be hidden.
* @param extraPlayersEnabled
* Whether the extra players option should be enabled.
* @param maxPlayersEnabled
* Whether the max players option should be enabled.
* @param extraPlayersCount
* The number to add to the online players for the extra players.
* @param maxPlayersCount
* The number to use for the max players count.
*
* @see Builder ProfileEntry.Builder
*/
Expand All @@ -68,6 +73,7 @@ public record ProfileEntry(List<String> motd, List<String> players, String playe
CheckUtil.isNull("Players", players);
CheckUtil.isNull("HidePlayersEnabled", hidePlayersEnabled);
CheckUtil.isNull("ExtraPlayersEnabled", extraPlayersEnabled);
CheckUtil.isNull("MaxPlayersEnabled", maxPlayersEnabled);
}

/**
Expand All @@ -79,14 +85,16 @@ public record ProfileEntry(List<String> motd, List<String> players, String playe
* <li>{@link #favicon() favicon}: Empty String</li>
* <li>{@link #hidePlayersEnabled() hidePlayersEnabled}: {@link NullBool#NOT_SET NullBool.NOT_SET}</li>
* <li>{@link #extraPlayersEnabled() extraPlayersEnabled}: {@link NullBool#NOT_SET NullBool.NOT_SET}</li>
* <li>{@link #maxPlayersEnabled() maxPlayersEnabled}: {@link NullBool#NOT_SET NullBoo.NOT_SET}</li>
* <li>{@link #extraPlayersCount() extraPlayersCount}: {@code null}</li>
* <li>{@link #maxPlayersCount() maxPlayersCount}: {@code null}</li>
* </ul>
*
* @return New ProfileEntry instance with empty/null values defined.
*/
public static ProfileEntry empty(){
return new ProfileEntry(Collections.emptyList(), Collections.emptyList(), "", "",
NullBool.NOT_SET, NullBool.NOT_SET, null);
NullBool.NOT_SET, NullBool.NOT_SET, NullBool.NOT_SET, null, null);
}

/**
Expand Down Expand Up @@ -125,7 +133,9 @@ public Builder builder(){
.setFavicon(favicon())
.setHidePlayersEnabled(hidePlayersEnabled())
.setExtraPlayersEnabled(extraPlayersEnabled())
.setExtraPlayerCount(extraPlayersCount());
.setMaxPlayersEnabled(maxPlayersEnabled())
.setExtraPlayersCount(extraPlayersCount())
.setMaxPlayersCount(maxPlayersCount());
}

/**
Expand Down Expand Up @@ -196,6 +206,17 @@ public NullBool extraPlayersEnabled(){
return extraPlayersEnabled;
}

/**
* Whether the max players feature should be used or not.
* <br>To get the actual boolean value, use {@link NullBool#getOrDefault(boolean) getValue(boolean)}.
*
* @return Whether the max players feature should be used or not.
*/
@Override
public NullBool maxPlayersEnabled(){
return maxPlayersEnabled;
}

/**
* Gets the currently set number of extra players of this ProfileEntry.
*
Expand All @@ -206,6 +227,16 @@ public Integer extraPlayersCount(){
return extraPlayersCount;
}

/**
* Gets the currently set number of max players of this ProfileEntry.
*
* @return The current number of max players used by this ProfileEntry.
*/
@Override
public Integer maxPlayersCount(){
return maxPlayersCount;
}

/**
* Whether this ProfileEntry is invalid or not.
* <br>The ProfileEntry is considered invalid if all the following is true:
Expand Down Expand Up @@ -237,7 +268,9 @@ public static class Builder{
private String favicon = "";
private NullBool hidePlayersEnabled = NullBool.NOT_SET;
private NullBool extraPlayersEnabled = NullBool.NOT_SET;
private NullBool maxPlayersEnabled = NullBool.NOT_SET;
private Integer extraPlayersCount = null;
private Integer maxPlayersCount = null;

public Builder(){}

Expand Down Expand Up @@ -363,29 +396,86 @@ public Builder setExtraPlayersEnabled(NullBool extraPlayersEnabled){
return this;
}

/**
* Sets whether the max players feature should be enabled.
*
* <p>Set to {@link NullBool#NOT_SET NullBool.NOT_SET} to not set this.
*
* <p>An {@link java.lang.IllegalArgumentException IllegalArgumentException} may be thrown by the
* {@link CheckUtil CheckUtil} should maxPlayersEnabled be null.
*
* @param maxPlayersEnabled
* Whether the extra players feature should be enabled or not.
*
* @return This Builder after the NullBool has been set. Useful for chaining.
*/
public Builder setMaxPlayersEnabled(NullBool maxPlayersEnabled){
CheckUtil.isNull("MaxPlayersEnabled", maxPlayersEnabled);

this.maxPlayersEnabled = maxPlayersEnabled;
return this;
}

/**
* Sets the number of players to add to the online players to use as the new max players.
* <br>This option has no effect when {@link #extraPlayersEnabled() isExtraPlayersEnabled} is set to {@code false}.
* <br>This option has no effect when {@link #extraPlayersEnabled() extraPlayersEnabled} is set to {@code false}.
*
* <p>Set this to {@code null} to not alter the max player count. Alternatively {@link #setExtraPlayersEnabled(NullBool) disable extra Players}.
*
* @param extraPlayersCount
* The number of extra players to add.
*
* @return This Builder after the extra player count has been set. Useful for chaining.
*
* @deprecated Typo in the name. Use {@link #setExtraPlayersCount(Integer) setExtraPlayersCount(Integer)} instead.
*/
@Deprecated(since = "3.1.0", forRemoval = true)
public Builder setExtraPlayerCount(Integer extraPlayersCount){
return setExtraPlayersCount(extraPlayersCount);
}

/**
* Sets the number of players to add to the online players to use as the new max players.
* <br>This option has no effect when {@link #extraPlayersEnabled() extraPlayersEnabled} is set to
* {@link NullBool#FALSE NullBool.FALSE} or {@link NullBool#NOT_SET NullBool.NOT_SET}.
*
* <p>Set this to {@code null} to not alter the max player count. Alternatively {@link #setExtraPlayersEnabled(NullBool) disable extra Players}.
*
* @param extraPlayersCount
* The number of extra players to add.
*
* @return This Builder after the extra player count has been set. Useful for chaining.
*/
public Builder setExtraPlayersCount(Integer extraPlayersCount){
this.extraPlayersCount = extraPlayersCount;
return this;
}

/**
* Sets the number of max players allowed to join this server.
* <br>This option has no effect when {@link #maxPlayersEnabled() maxPlayersEnabled} is set to
* {@link NullBool#FALSE NullBool.FALSE} or {@link NullBool#NOT_SET NullBool.NOT_SET}.
*
* <p>Set this to {@code null} to not alter the max player count. Alternatively {@link #setMaxPlayersEnabled(NullBool) disable max Players}.
*
* @param maxPlayersCount
* The number of max players to set.
*
* @return This Builder after the max player count has been set. Useful for chaining.
*/
public Builder setMaxPlayersCount(Integer maxPlayersCount){
this.maxPlayersCount = maxPlayersCount;
return this;
}

/**
* Creates a new {@link ProfileEntry ProfileEntry instance} with the values set in this Builder.
*
* @return New {@link ProfileEntry ProfileEntry instance}.
*/
public ProfileEntry build(){
return new ProfileEntry(motd, players, playerCountText, favicon, hidePlayersEnabled, extraPlayersEnabled, extraPlayersCount);
return new ProfileEntry(motd, players, playerCountText, favicon, hidePlayersEnabled, extraPlayersEnabled,
maxPlayersEnabled, extraPlayersCount, maxPlayersCount);
}
}
}

0 comments on commit 873d949

Please sign in to comment.