Class BridgeDocProperties

java.lang.Object

eu.cloudnetservice.modules.bridge.BridgeDocProperties

public final class BridgeDocProperties
extends Object

The bridge service properties are there to read any properties set by the bridge module. It is important to note that not all values are set by default and most values cannot be overridden. For these values to be set, the bridge must run as a plugin on the respective service.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final eu.cloudnetservice.driver.document.property.DocProperty<String>	EXTRA	This service property reads the extra value of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<Boolean>	IS_ONLINE	This service property reads the online property of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<Integer>	MAX_PLAYERS	This service property reads the max player count of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<String>	MOTD	This service property reads the motd of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<Integer>	ONLINE_COUNT	This service property reads the online player count of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<Collection<ServicePlayer>>	PLAYERS	This service property allows accessing all players that are connected to the given service.
static final eu.cloudnetservice.driver.document.property.DocProperty<String>	REQUIRED_PERMISSION	This property holds the required permission that a player must have to join a specific service.
static final eu.cloudnetservice.driver.document.property.DocProperty<String>	STATE	This service property reads the state of any given ServiceInfoSnapshot.
static final eu.cloudnetservice.driver.document.property.DocProperty<String>	VERSION	This service property reads the version of any given ServiceInfoSnapshot.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BridgeDocProperties()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REQUIRED_PERMISSION

public static final eu.cloudnetservice.driver.document.property.DocProperty<String> REQUIRED_PERMISSION

This property holds the required permission that a player must have to join a specific service. If the property is not set, the player is unable to join. This property defaults to null with indicates that no permission is required to join the service.

Note: this property only has effect when applied to the associated service task of a service.

ONLINE_COUNT

public static final eu.cloudnetservice.driver.document.property.DocProperty<Integer> ONLINE_COUNT

This service property reads the online player count of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

MAX_PLAYERS

public static final eu.cloudnetservice.driver.document.property.DocProperty<Integer> MAX_PLAYERS

This service property reads the max player count of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

VERSION

public static final eu.cloudnetservice.driver.document.property.DocProperty<String> VERSION

This service property reads the version of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

MOTD

public static final eu.cloudnetservice.driver.document.property.DocProperty<String> MOTD

This service property reads the motd of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

Setting the state is possible using BridgeServiceHelper.motd() on the service itself.

EXTRA

public static final eu.cloudnetservice.driver.document.property.DocProperty<String> EXTRA

This service property reads the extra value of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

Setting the state is possible using BridgeServiceHelper.extra() on the service itself.

STATE

public static final eu.cloudnetservice.driver.document.property.DocProperty<String> STATE

This service property reads the state of any given ServiceInfoSnapshot. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

Setting the state is possible using BridgeServiceHelper.state() on the service itself.

IS_ONLINE

public static final eu.cloudnetservice.driver.document.property.DocProperty<Boolean> IS_ONLINE

This service property reads the online property of any given ServiceInfoSnapshot. This property is always true after the bridge plugin was enabled. The property is only updated after the service itself was updated.

Note: This property is not modifiable, modifying it results in an UnsupportedOperationException.

PLAYERS

public static final eu.cloudnetservice.driver.document.property.DocProperty<Collection<ServicePlayer>> PLAYERS

This service property allows accessing all players that are connected to the given service. The property is only updated after the service itself was updated.

Note: Writing to this property is not allowed it results in an UnsupportedOperationException.

Constructor Details

BridgeDocProperties

private BridgeDocProperties()