Class NetworkClusterNode

java.lang.Object

eu.cloudnetservice.driver.cluster.NetworkClusterNode

All Implemented Interfaces:

DefaultedDocPropertyHolder, DocPropertyHolder

public final class NetworkClusterNode
extends Object
implements DefaultedDocPropertyHolder

Represents a general information holder about a node running in a cluster. Every node knows this information about each node which runs in the cluster, even if the node is not connected.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

DefaultedDocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Field Summary

Fields

Modifier and Type	Field	Description
private final List<HostAndPort>	listeners
private final Document	properties
private final String	uniqueId

Constructor Summary

Constructors

Constructor	Description
NetworkClusterNode(@NonNull String uniqueId, @NonNull List<HostAndPort> listeners)	Creates a new instance of a network cluster node.
NetworkClusterNode(@NonNull String uniqueId, @NonNull List<HostAndPort> listeners, @NonNull Document properties)	Creates a new instance of a network cluster node.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
int	hashCode()
@NonNull List<HostAndPort>	listeners()	Get all listener of this node.
@NonNull Document	propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull String	uniqueId()	Get the unique id of this node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow

Field Details

uniqueId

private final String uniqueId

listeners

private final List<HostAndPort> listeners

properties

private final Document properties

Constructor Details

NetworkClusterNode

public NetworkClusterNode(@NonNull
 @NonNull String uniqueId,
 @NonNull
 @NonNull List<HostAndPort> listeners)

Creates a new instance of a network cluster node.

Parameters:

uniqueId - the unique id of the node.

listeners - the listeners of the node which are always running.

Throws:

NullPointerException - if either the id or listener array is null.

NetworkClusterNode

public NetworkClusterNode(@NonNull
 @NonNull String uniqueId,
 @NonNull
 @NonNull List<HostAndPort> listeners,
 @NonNull
 @NonNull Document properties)

Creates a new instance of a network cluster node.

Parameters:

uniqueId - the unique id of the node.

listeners - the listeners of the node which are always running.

properties - the properties which are set for this node, mainly for developers to store information.

Throws:

NullPointerException - if either the id or listener array is null.

Method Details

uniqueId

@NonNull
public @NonNull String uniqueId()

Get the unique id of this node.

Returns:

the unique id of this node.

listeners

@NonNull
public @NonNull List<HostAndPort> listeners()

Get all listener of this node.

Returns:

all listener of this node.

propertyHolder

@NonNull
public @NonNull Document propertyHolder()

Get the underlying document that all read and write operations are delegated to.

Specified by:

propertyHolder in interface DocPropertyHolder

Returns:

the underlying document.

equals

public boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object