Package org.sgrewritten.stargate.property

Enum Class PluginChannel

java.lang.Object
java.lang.Enum<PluginChannel>
org.sgrewritten.stargate.property.PluginChannel
All Implemented Interfaces:
Serializable, Comparable<PluginChannel>, Constable
public enum PluginChannel extends Enum<PluginChannel>
The channel represents the different usable plugin channels that can be used with BungeeCord

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BUNGEE
    Represents the BungeeCord plugin channel
    FORWARD
    Represents the BungeeCord sub-channel for forwarding a custom plugin message to another server
    GET_SERVER
    Represents the BungeeCord sub-channel for getting the name of this server
    LEGACY_BUNGEE
    Represents the custom forwarding sub-channel used by legacy stargate plugins; for backwards compatibility
    NETWORK_CHANGED
    Represents the custom forwarding sub-channel used when a stargate is added to or removed from a network
    PLAYER_CONNECT
    Represents the BungeeCord sub-channel for making a player connect to a server
    PLAYER_TELEPORT
    Represents the custom forwarding sub-channel used when a player is teleported from a stargate through BungeeCord
    PLUGIN_DISABLE
    Represents the custom forwarding sub-channel used for nothing ???
    PLUGIN_ENABLE
    Represents the custom forwarding sub-channel used for nothing ???

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChannel()
    Gets this plugin channel's name/string representation
    static PluginChannel
    parse(String channel)
    Parses a channel's string representation into a channel enum
    static PluginChannel
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PluginChannel[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BUNGEE

      public static final PluginChannel BUNGEE
      Represents the BungeeCord plugin channel

    • GET_SERVER

      public static final PluginChannel GET_SERVER
      Represents the BungeeCord sub-channel for getting the name of this server

    • PLAYER_CONNECT

      public static final PluginChannel PLAYER_CONNECT
      Represents the BungeeCord sub-channel for making a player connect to a server

    • FORWARD

      public static final PluginChannel FORWARD
      Represents the BungeeCord sub-channel for forwarding a custom plugin message to another server

    • PLAYER_TELEPORT

      public static final PluginChannel PLAYER_TELEPORT
      Represents the custom forwarding sub-channel used when a player is teleported from a stargate through BungeeCord

    • NETWORK_CHANGED

      public static final PluginChannel NETWORK_CHANGED
      Represents the custom forwarding sub-channel used when a stargate is added to or removed from a network

    • LEGACY_BUNGEE

      public static final PluginChannel LEGACY_BUNGEE
      Represents the custom forwarding sub-channel used by legacy stargate plugins; for backwards compatibility

    • PLUGIN_ENABLE

      public static final PluginChannel PLUGIN_ENABLE
      Represents the custom forwarding sub-channel used for nothing ???

    • PLUGIN_DISABLE

      public static final PluginChannel PLUGIN_DISABLE
      Represents the custom forwarding sub-channel used for nothing ???

  • Method Details

    • values

      public static PluginChannel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PluginChannel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getChannel

      public String getChannel()
      Gets this plugin channel's name/string representation
      Returns:

      This plugin channel's string representation

    • parse

      public static PluginChannel parse(String channel)
      Parses a channel's string representation into a channel enum
      Parameters:
      channel -

      The channel name to parse

      Returns:

      The matching channel enum, or null if no match was found