Interface ServerStatus

public sealed interface ServerStatus
Server status data returned to during the status ping.
Since:
0.1.0

  • Method Details

    • description

      @Contract(pure=true) Component description()
      Gets the status description (also referred to as MOTD).
      Returns:
      status description
      Since:
      0.1.0

    • version

      @Contract(pure=true) ServerStatus.Version version()
      Gets the server version used in the status response.
      Returns:
      server version
      Since:
      0.1.0

    • favicon

      @Contract(pure=true) Optional<Favicon> favicon()
      Gets the optional server favicon.
      Returns:
      favicon, or an empty optional if none is configured
      Since:
      0.1.0

    • maxPlayers

      @Contract(pure=true) int maxPlayers()
      Gets the maximum player count shown in the status response.
      Returns:
      displayed maximum player count
      Since:
      0.1.0

    • players

      @Contract(pure=true) int players()
      Gets the online player count shown in the status response.
      Returns:
      displayed online player count
      Since:
      0.1.0

    • samplePlayers

      @Contract(pure=true) @Unmodifiable List<ServerStatus.SamplePlayer> samplePlayers()
      Gets the sample player entries shown in the status response.
      Returns:
      unmodifiable sample player list
      Since:
      0.1.0

    • enforceSecureChat

      @Contract(pure=true) boolean enforceSecureChat()
      Gets whether secure chat is enforced on this server.
      Returns:
      true if secure chat is enforced
      Since:
      0.1.0

    • toBuilder

      @Contract(value=" -> new", pure=true) ServerStatus.Builder toBuilder()
      Creates a builder initialized with this status.
      Returns:
      new builder containing this status data
      Since:
      0.1.0

    • builder

      @Contract(value=" -> new", pure=true) static ServerStatus.Builder builder()
      Creates a new server status builder.
      Returns:
      new builder
      Since:
      0.1.0