Skip to content

Builder

Builder class to create a new ProfileEntry instance.

Constructor Summary

Constructor Description
Builder()

Method Summary

Modifier and Type Method Description
Builder setMotd(List<String>) Sets a new MOTD to use.
Builder setPlayers(List<String>) Sets the players (lines) to use for the hover.
Builder setPlayerCountText(String) Sets the text to override the player count with.
Builder setFavicon(String) Sets the value to use for the favicon.
Builder setHidePlayersEnabled(NullBool) Sets whether the player count should be hidden or not.
Builder setExtraPlayersEnabled(NullBool) Sets whether the extra players feature should be enabled or not.
Builder setMaxPlayersEnabled(NullBool) Sets whether the max players feature should be enabled.
Builder setExtraPlayerCount(Integer)
Typo in the name. Use setExtraPlayersCount(Integer) instead.
Builder setExtraPlayersCount(Integer) Sets the number of players to add to the online players to use as the new max players value.
Builder setMaxPlayersCount(Integer) Sets the number of max players allowed to join this server.
ProfileEntry build() Creates a new ProfileEntry instance with the values set in this Builder.

Constructor Detail

Builder()

Method Detail

Builder setMotd(List<String>)

Sets a new MOTD to use.

Set to an empty list to not change the MOTD.
Only the first two entries of the list will be considered and any additional ones discarded.

Parameters:

  • List<String>: motd - The MOTD to use.

Returns:

This Builder after the motd has been set. Useful for chaining.

Throws:

  • IllegalArgumentException - Thrown by the CheckUtil in case null has been provided as parameter.

Builder setPlayers(List<String>)

Sets the players (lines) to use for the hover.

Set to an empty list to not change the hover text.

Parameters:

  • List<String>: players - The lines to set for the hover.

Returns:

This Builder after the players have been set. Useful for chaining.

Throws:

  • IllegalArgumentException - Thrown by the CheckUtil in case null has been provided as parameter.

Builder setPlayerCountText(String)

Sets the text to override the player count with.

Set to an empty String or null to not alter the player count text.

Parameters:

  • String: playerCountText - The text to show in the player count.

Returns:

This Builder after the player count text has been set. Useful for chaining.

Builder setFavicon(String)

Sets the value to use for the favicon.
The following values are supported:

  • URL to a valid PNG file.
  • File name (with .png extension) matching a file saved in the favicons folder of AdvancedServerList.
  • ${player uuid} to display the avatar of the player.

Parameters:

  • String: favicon - The favicon to set

Returns:

This Builder after the favicon has been set. Useful for chaining.

Builder setHidePlayersEnabled(NullBool)

Sets whether the player count should be hidden or not.

Set to NullBool.NOT_SET to not set this.

Parameters:

  • NullBool: hidePlayersEnabled - Whether the player count should be hidden or not.

Returns:

This Builder after the NullBool has been set. Useful for chaining.

Throws:

  • IllegalArgumentException - Thrown by the CheckUtil in case null has been provided as parameter.

Builder setExtraPlayersEnabled(NullBool)

Sets whether the extra players feature should be enabled or not.

Set to NullBool.NOT_SET to not set this.

Parameters:

  • NullBool: extraPlayersEnabled - Whether the extra players feature should be enabled or not.

Returns:

This Builder after the NullBool has been set. Useful for chaining.

Throws:

  • IllegalArgumentException - Thrown by the CheckUtil in case null has been provided as parameter.

Builder setMaxPlayersEnabled(NullBool)

Sets whether the max players feature should be enabled.

Set to NullBool.NOT_SET to not set this.

Parameters:

  • NullBool: maxPlayersEnabled - Whether the extra players feature should be enabled or not.

Returns:

This Builder after the NullBool has been set. Useful for chaining.

Throws:

  • IllegalArgumentException - Thrown by the CheckUtil in case null has been provided as parameter.

Builder setExtraPlayerCount(Integer)

Deprecation Warning

Typo in the name. Use setExtraPlayersCount(Integer) instead.

Sets the number of players to add to the online players to use as the new max players value.
This option has no effect when extraPlayersEnabled is set to NullBool.FALSE or NullBool.NOT_SET.

Set this to null to not alter the max player count. Alternatively, set setExtraPlayersEnabled(NullBool) to NullBool.FALSE.

Parameters:

  • Integer: extraPlayersCount - The number of extra players to add.

Returns:

This Builder after the extra player count has been set. Useful for chaining.

Builder setExtraPlayersCount(Integer)

Sets the number of players to add to the online players to use as the new max players value.
This option has no effect when extraPlayersEnabled is set to NullBool.FALSE or NullBool.NOT_SET.

Set this to null to not alter the max player count. Alternatively, set setExtraPlayersEnabled(NullBool) to NullBool.FALSE.

Parameters:

  • Integer: extraPlayersCount - The number of extra players to add.

Returns:

This Builder after the extra player count has been set. Useful for chaining.

Builder setMaxPlayersCount(Integer)

Sets the number of max players allowed to join this server.
This option has no effect when maxPlayersEnabled is set to NullBool.FALSE or NullBool.NOT_SET.

Set this to null to not alter the max player count. Alternatively, set setMaxPlayersEnabled(NullBool) to NullBool.FALSE.

Parameters:

  • Integer: maxPlayersCount - The number of max players to set.

Returns:

This Builder after the extra player count has been set. Useful for chaining.

ProfileEntry build()

Creates a new ProfileEntry instance with the values set in this Builder.

Returns:

New ProfileEntry instance.