me.ryandw11.ultrachat.api.managers

Class ChannelManager

java.lang.Object

me.ryandw11.ultrachat.api.managers.ChannelManager

public class ChannelManager
extends java.lang.Object

This class handles the channels of the plugin.

Get the instance of this class from UltraChatAPI.getChannelManager()

Constructor Summary

Constructors

Constructor and Description
ChannelManager()

Method Summary

Modifier and Type	Method and Description
boolean	channelExists(ChatChannel channel) If a given channel exists (In this instance if it is save in the files)
boolean	channelExists(java.lang.String name) If a given channel exists based upon the name.
java.util.List<java.util.UUID>	getAllPlayersInChannel(ChatChannel channel) Get all players in a channel online or offline.
ChatChannel	getChannelByName(java.lang.String name) Get a channel via its name
ChatChannel	getDefaultChannel() Get the servers default channel.
ChatChannel	getPlayerChannel(org.bukkit.entity.Player player) Grab the player's current channel.
ChatChannel	getPlayerChannel(java.util.UUID player) Grab an offline player's current channel.
java.util.List<org.bukkit.entity.Player>	getPlayersInChannel(ChatChannel channel) Get all online players in a given channel.
void	setDefaultChannel(ChatChannel channel) Set the default channel
void	setPlayerChannel(org.bukkit.entity.Player player, ChatChannel channel) Set the player's channel.
void	setPlayerChannel(java.util.UUID player, ChatChannel channel) Set the player's channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelManager

public ChannelManager()

Method Detail

getChannelByName

public ChatChannel getChannelByName(java.lang.String name)

Get a channel via its name

Parameters:

name - The name of the channel

Returns:

The channel.

getPlayerChannel

public ChatChannel getPlayerChannel(org.bukkit.entity.Player player)

Grab the player's current channel.

Parameters:

player - The player to get the channel from.

Returns:

The player's current channel.

getPlayerChannel

public ChatChannel getPlayerChannel(java.util.UUID player)

Grab an offline player's current channel.

Parameters:

player - The player to get the channel from.

Returns:

That UUID's current channel.

getDefaultChannel

public ChatChannel getDefaultChannel()

Get the servers default channel.

Returns:

Default Channel

setPlayerChannel

public void setPlayerChannel(org.bukkit.entity.Player player,
                             ChatChannel channel)

Set the player's channel.

Parameters:

player - The player to set.

channel - The channel.

setPlayerChannel

public void setPlayerChannel(java.util.UUID player,
                             ChatChannel channel)

Set the player's channel.

Parameters:

player - The player to set.

channel - The channel.

setDefaultChannel

public void setDefaultChannel(ChatChannel channel)

Set the default channel

Parameters:

channel - The channel.

channelExists

public boolean channelExists(ChatChannel channel)

If a given channel exists (In this instance if it is save in the files)

Parameters:

channel - The channel to check.

Returns:

If the channel exists.

channelExists

public boolean channelExists(java.lang.String name)

If a given channel exists based upon the name.

Parameters:

name - The name of the channel to check

Returns:

If the channel exists.

getPlayersInChannel

public java.util.List<org.bukkit.entity.Player> getPlayersInChannel(ChatChannel channel)

Get all online players in a given channel.

Parameters:

channel - The channel to get the players from.

Returns:

The list of players. (Unmodifiable)

getAllPlayersInChannel

public java.util.List<java.util.UUID> getAllPlayersInChannel(ChatChannel channel)

Get all players in a channel online or offline.

Parameters:

channel - The channel to get the UUIDs from.

Returns:

The list of UUIDs. (Unmodifiable)