Interface ServerStatus.Builder

Enclosing interface:

ServerStatus

public static sealed interface ServerStatus.Builder

Builds immutable server status instances.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
ServerStatus	build()	Builds a server status instance.
ServerStatus.Builder	description(Component description)	Sets the status description.
ServerStatus.Builder	enforceSecureChat(boolean enforceSecureChat)	Sets whether secure chat is enforced.
ServerStatus.Builder	favicon(@Nullable Favicon favicon)	Sets the favicon.
ServerStatus.Builder	maxPlayers(int maxPlayers)	Sets the displayed maximum player count.
ServerStatus.Builder	players(int players)	Sets the displayed online player count.
ServerStatus.Builder	samplePlayer(ServerStatus.SamplePlayer samplePlayer)	Adds a sample player entry.
ServerStatus.Builder	samplePlayers(List<ServerStatus.SamplePlayer> samplePlayers)	Replaces the sample player list.
ServerStatus.Builder	version(ServerStatus.Version version)	Sets the displayed server version.

Method Details

description

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder description(Component description)

Sets the status description.

Parameters:

description - status description

Returns:

this builder

Since:

0.1.0

version

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder version(ServerStatus.Version version)

Sets the displayed server version.

Parameters:

version - displayed version

Returns:

this builder

Since:

0.1.0

favicon

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder favicon(@Nullable Favicon favicon)

Sets the favicon.

Parameters:

favicon - favicon to display, or null to omit one

Returns:

this builder

Since:

0.1.0

maxPlayers

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder maxPlayers(int maxPlayers)

Sets the displayed maximum player count.

Parameters:

maxPlayers - maximum player count

Returns:

this builder

Since:

0.1.0

players

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder players(int players)

Sets the displayed online player count.

Parameters:

players - online player count

Returns:

this builder

Since:

0.1.0

samplePlayers

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder samplePlayers(List<ServerStatus.SamplePlayer> samplePlayers)

Replaces the sample player list.

Parameters:

samplePlayers - sample players to display

Returns:

this builder

Since:

0.1.0

samplePlayer

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder samplePlayer(ServerStatus.SamplePlayer samplePlayer)

Adds a sample player entry.

Parameters:

samplePlayer - sample player to add

Returns:

this builder

Since:

0.1.0

enforceSecureChat

@Contract(value="_ -> this",
          mutates="this")
ServerStatus.Builder enforceSecureChat(boolean enforceSecureChat)

Sets whether secure chat is enforced.

Parameters:

enforceSecureChat - enforce secure chat

Returns:

this builder

Since:

0.1.0

build

@Contract(value=" -> new",
          pure=true)
ServerStatus build()

Builds a server status instance.

Returns:

server status

Since:

0.1.0