net.tridentsdk.plugin.channel

Class PluginChannels

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<PluginChannel>

net.tridentsdk.plugin.channel.PluginChannels

All Implemented Interfaces:

Iterable<PluginChannel>, Collection<PluginChannel>, Registry<PluginChannel>

@ThreadSafe
public abstract class PluginChannels
extends com.google.common.collect.ForwardingCollection<PluginChannel>
implements Registry<PluginChannel>

Manages data channels for sending information over the pipeline

To access this handler, use this code:

     PluginChannels handler = Registered.channels();
 

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
PluginChannels() Do not instantiate

Method Summary

Modifier and Type	Method and Description
protected Collection<PluginChannel>	delegate()
PluginChannel	fromName(String name) Find a channel by its name
void	register(String name, PluginChannel channel) Registers a channel in the listings
protected abstract void	sendPluginMessage(String channel, byte... data) Send a plugin message
void	unregister(String name) Removes a channel if it exists in the listings

Methods inherited from class com.google.common.collect.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PluginChannels

public PluginChannels()

Do not instantiate

To access this handler, use this code:

     PluginChannels handler = Registered.channels();
 

Method Detail

sendPluginMessage

protected abstract void sendPluginMessage(String channel,
                                          byte... data)

Send a plugin message

Parameters:

channel - name of the channel

data - the data to send

register

public void register(String name,
                     PluginChannel channel)

Registers a channel in the listings

Parameters:

name - the name of the channel

channel - the channel to register

unregister

public void unregister(String name)

Removes a channel if it exists in the listings

Parameters:

name - the name of the channel to remove

fromName

public PluginChannel fromName(String name)

Find a channel by its name

Parameters:

name - the name to find the channel by

Returns:

the channel having the specified name

delegate

protected Collection<PluginChannel> delegate()

Overrides:

delegate in class com.google.common.collect.ForwardingCollection<PluginChannel>