org.bspfsystems.bungeeipc.api.client

Class ClientIPCMessage

java.lang.Object

org.bspfsystems.bungeeipc.api.common.AbstractIPCMessage

org.bspfsystems.bungeeipc.api.client.ClientIPCMessage

All Implemented Interfaces:

IPCMessage

public final class ClientIPCMessage
extends AbstractIPCMessage

Represents the client-side extension of an AbstractIPCMessage.

Field Summary

Fields inherited from class org.bspfsystems.bungeeipc.api.common.AbstractIPCMessage

SEPARATOR

Fields inherited from interface org.bspfsystems.bungeeipc.api.common.IPCMessage

BROADCAST_SERVER, PLACEHOLDER_SERVER, PROXY_SERVER

Constructor Summary

Constructors

Constructor and Description
ClientIPCMessage(@NotNull String destination, @NotNull String channel) Constructs a new IPCMessage with no data that originates on a Bukkit server.
ClientIPCMessage(@NotNull String destination, @NotNull String channel, @NotNull List<String> data) Constructs a new IPCMessage containing the initial data in the given List.
ClientIPCMessage(@NotNull String destination, @NotNull String channel, @NotNull Queue<String> data) Constructs a new IPCMessage containing the initial data in the given Queue.

Method Summary

Methods inherited from class org.bspfsystems.bungeeipc.api.common.AbstractIPCMessage

add, getChannel, getDestination, getOrigin, hasNext, next, toString, validateNotBlank, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientIPCMessage

public ClientIPCMessage(@NotNull
                        @NotNull String destination,
                        @NotNull
                        @NotNull String channel)
                 throws IllegalArgumentException

Constructs a new IPCMessage with no data that originates on a Bukkit server.

Parameters:

destination - The destination IPCSocket.

channel - The channel the IPCMessage will be read by.

Throws:

IllegalArgumentException - If destination and/or channel are blank.

See Also:

AbstractIPCMessage(String, String, String)

ClientIPCMessage

public ClientIPCMessage(@NotNull
                        @NotNull String destination,
                        @NotNull
                        @NotNull String channel,
                        @NotNull
                        @NotNull List<String> data)
                 throws IllegalArgumentException

Constructs a new IPCMessage containing the initial data in the given List. This message originates on a Bukkit server. Order of the items in the List will be maintained.

Parameters:

destination - The destination IPCSocket.

channel - The channel the IPCMessage will be read by.

data - The initial data as a List. Order will be maintained.

Throws:

IllegalArgumentException - If destination and/or channel are blank, or if any element in data is null.

See Also:

AbstractIPCMessage(String, String, String, List)

ClientIPCMessage

public ClientIPCMessage(@NotNull
                        @NotNull String destination,
                        @NotNull
                        @NotNull String channel,
                        @NotNull
                        @NotNull Queue<String> data)
                 throws IllegalArgumentException

Constructs a new IPCMessage containing the initial data in the given Queue. This message originates on a Bukkit server. Order of the items in the Queue will be maintained.

Parameters:

destination - The destination IPCSocket.

channel - The channel the IPCMessage will be read by.

data - The initial data as a Queue. Order will be maintained.

Throws:

IllegalArgumentException - If destination and/or channel are blank, or if any element in data is null.

See Also:

AbstractIPCMessage(String, String, String, Queue)