Class ChannelMessage.Builder

java.lang.Object

eu.cloudnetservice.driver.channel.ChannelMessage.Builder

Enclosing class:

ChannelMessage

public static final class ChannelMessage.Builder
extends Object

A builder for a channel message. This class should be used over direct constructor access as allows better customization and validation of a channel message which gets created. Required properties are:

• channel, can be empty
• message, can be empty
• at least one target for the message

If no sender of the message is given the current network component will be used as the sender of the message.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	channel
private DataBuf	content
private String	message
private boolean	prioritized
private ChannelMessageSender	sender
private boolean	sendSync
private final Collection<ChannelMessageTarget>	targets

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull ChannelMessage.Builder	buffer(@Nullable DataBuf dataBuf)	Sets the content of this message.
@NonNull ChannelMessage	build()	Builds a channel message from this builder within the contract given in the Builder class java docs.
@NonNull ChannelMessage.Builder	channel(@NonNull String channel)	Sets the channel of this message.
@NonNull ChannelMessage.Builder	message(@NonNull String message)	Sets the message key of this message.
@NonNull ChannelMessage.Builder	prioritized(boolean prioritized)	Sets if the channel message should be prioritized over other channel messages.
@NonNull ChannelMessage.Builder	sender(@NonNull ChannelMessageSender sender)	Sets the sender of this message.
@NonNull ChannelMessage.Builder	sendSync(boolean sync)	Sets if the channel message should get send sync, blocking the sending thread until the message was written and flushed through the network layer.
@NonNull ChannelMessage.Builder	target(@NonNull DriverEnvironment environment, @Nullable String name)	Adds a channel message target to this message.
@NonNull ChannelMessage.Builder	target(@NonNull ChannelMessageTarget target)	Adds the given target as a target of this message.
@NonNull ChannelMessage.Builder	target(ChannelMessageTarget.Type type, @Nullable String name)	Adds a channel message target to this message.
@NonNull ChannelMessage.Builder	targetAll()	Targets all components within the network.
@NonNull ChannelMessage.Builder	targetAll(ChannelMessageTarget.Type type)	Targets all components with the given type.
@NonNull ChannelMessage.Builder	targetEnvironment(@NonNull ServiceEnvironmentType environment)	Targets all services with the given environment within the network.
@NonNull ChannelMessage.Builder	targetNode(@Nullable String name)	Targets a specific node within the network.
@NonNull ChannelMessage.Builder	targetNodes()	Targets all nodes within the network.
@NonNull ChannelMessage.Builder	targetService(@Nullable String name)	Targets a specific service in the network.
@NonNull ChannelMessage.Builder	targetServices()	Targets all services within the network.
@NonNull ChannelMessage.Builder	targetTask(@Nullable String name)	Targets all services of the given task within the network.

Methods inherited from class java.lang.Object

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

Field Details

targets

private final Collection<ChannelMessageTarget> targets

channel

private String channel

message

private String message

sendSync

private boolean sendSync

prioritized

private boolean prioritized

content

private DataBuf content

sender

private ChannelMessageSender sender

Constructor Details

Builder

public Builder()

Method Details

sender

@NonNull
public @NonNull ChannelMessage.Builder sender(@NonNull
 @NonNull ChannelMessageSender sender)

Sets the sender of this message. If no sender is given the current component will be used as the sender. Note that if you change the sender and try to receive a query response it will send the response to the given sender, not this component.

Parameters:

sender - the sender of this message.

Returns:

the same builder as used to call the method, for chaining.

Throws:

NullPointerException - if the given sender is null.

See Also:

• ChannelMessageSender.self()

channel

@NonNull
public @NonNull ChannelMessage.Builder channel(@NonNull
 @NonNull String channel)

Sets the channel of this message. Might be empty but should be unique to identify within the network.

Parameters:

channel - the channel.

Returns:

the same builder as used to call the method, for chaining.

Throws:

NullPointerException - if the given channel is null.

message

@NonNull
public @NonNull ChannelMessage.Builder message(@NonNull
 @NonNull String message)

Sets the message key of this message. Might be empty but should be unique to identify within the network.

Parameters:

message - the message key.

Returns:

the same builder as used to call the method, for chaining.

Throws:

NullPointerException - if the given message is null.

sendSync

@NonNull
public @NonNull ChannelMessage.Builder sendSync(boolean sync)

Sets if the channel message should get send sync, blocking the sending thread until the message was written and flushed through the network layer.

Parameters:

sync - if the message should get send sync.

Returns:

the same builder as used to call the method, for chaining.

prioritized

@Experimental
@NonNull
public @NonNull ChannelMessage.Builder prioritized(boolean prioritized)

Sets if the channel message should be prioritized over other channel messages.

USE WITH CAUTION! This can cause other packet to get read and handled delayed. Use this option only if you know what you're doing and are absolutely sure that the packet is urgent for CloudNet to work for as expected. Otherwise, don't touch this method.

Parameters:

prioritized - if the channel message is prioritized

Returns:

the same builder as used to call the method, for chaining.

buffer

@NonNull
public @NonNull ChannelMessage.Builder buffer(@Nullable
 @Nullable DataBuf dataBuf)

Sets the content of this message. If no content was given an empty buffer will be used.

Parameters:

dataBuf - the content.

Returns:

the same builder as used to call the method, for chaining.

target

@NonNull
public @NonNull ChannelMessage.Builder target(@NonNull
 @NonNull ChannelMessageTarget target)

Adds the given target as a target of this message.

Parameters:

target - the target to add.

Returns:

the same builder as used to call the method, for chaining.

Throws:

NullPointerException - if the given target is null.

target

@NonNull
public @NonNull ChannelMessage.Builder target(@NonNull
 ChannelMessageTarget.Type type,
 @Nullable
 @Nullable String name)

Adds a channel message target to this message. You may not target an environment using this method.

Parameters:

type - the type of the receiver.

name - the name of the receiver.

Returns:

the same builder as used to call the method, for chaining.

Throws:

IllegalArgumentException - if type is ChannelMessageTarget.Type.ENVIRONMENT

NullPointerException - if the given target type is null.

See Also:

• ChannelMessageTarget.of(ChannelMessageTarget.Type, String)

target

@NonNull
public @NonNull ChannelMessage.Builder target(@NonNull
 @NonNull DriverEnvironment environment,
 @Nullable
 @Nullable String name)

Adds a channel message target to this message. You may not target an environment using this method.

Parameters:

environment - the driver environment to target.

name - the name of the target, might be null to target all components with the given environment.

Returns:

the same builder as used to call the method, for chaining.

Throws:

IllegalArgumentException - if type is ChannelMessageTarget.Type.ENVIRONMENT

NullPointerException - if the given environment is null.

See Also:

• ChannelMessageTarget.of(ChannelMessageTarget.Type, String)

targetAll

@NonNull
public @NonNull ChannelMessage.Builder targetAll(@NonNull
 ChannelMessageTarget.Type type)

Targets all components with the given type. You may not target an environment using this method.

Parameters:

type - the type of the receivers to target.

Returns:

the same builder as used to call the method, for chaining.

Throws:

IllegalArgumentException - if type is ChannelMessageTarget.Type.ENVIRONMENT

NullPointerException - if the given target type is null.

See Also:

• ChannelMessageTarget.of(ChannelMessageTarget.Type, String)

targetAll

@NonNull
public @NonNull ChannelMessage.Builder targetAll()

Targets all components within the network.

Returns:

the same builder as used to call the method, for chaining.

Throws:

IllegalArgumentException - if type is ChannelMessageTarget.Type.ENVIRONMENT

See Also:

• ChannelMessageTarget.of(ChannelMessageTarget.Type, String)

targetServices

@NonNull
public @NonNull ChannelMessage.Builder targetServices()

Targets all services within the network.

Returns:

the same builder as used to call the method, for chaining.

Throws:

IllegalArgumentException - if type is ChannelMessageTarget.Type.ENVIRONMENT

See Also:

• ChannelMessageTarget.of(ChannelMessageTarget.Type, String)

targetService

@NonNull
public @NonNull ChannelMessage.Builder targetService(@Nullable
 @Nullable String name)

Targets a specific service in the network.

Parameters:

name - the name of the service to target.

Returns:

the same builder as used to call the method, for chaining.

targetTask

@NonNull
public @NonNull ChannelMessage.Builder targetTask(@Nullable
 @Nullable String name)

Targets all services of the given task within the network.

Parameters:

name - the name of the task to target.

Returns:

the same builder as used to call the method, for chaining.

targetNode

@NonNull
public @NonNull ChannelMessage.Builder targetNode(@Nullable
 @Nullable String name)

Targets a specific node within the network.

Parameters:

name - the name of the node to target.

Returns:

the same builder as used to call the method, for chaining.

targetNodes

@NonNull
public @NonNull ChannelMessage.Builder targetNodes()

Targets all nodes within the network.

Returns:

the same builder as used to call the method, for chaining.

targetEnvironment

@NonNull
public @NonNull ChannelMessage.Builder targetEnvironment(@NonNull
 @NonNull ServiceEnvironmentType environment)

Targets all services with the given environment within the network.

Parameters:

environment - the environment to target.

Returns:

the same builder as used to call the method, for chaining.

Throws:

NullPointerException - if the given environment is null.

build

@Contract(" -> new")
@NonNull
public @NonNull ChannelMessage build()

Builds a channel message from this builder within the contract given in the Builder class java docs.

Returns:

the created channel message from this builder.

Throws:

NullPointerException - if no message or channel is provided.

IllegalArgumentException - if no target was specified.