Enum Class ConnectionState

java.lang.Object
java.lang.Enum<ConnectionState>
net.ME1312.SubData.Client.Library.ConnectionState
All Implemented Interfaces:
Serializable, Comparable<ConnectionState>, java.lang.constant.Constable

public enum ConnectionState extends Enum<ConnectionState>
Connection State Enum
  • 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
    This means that the connection is closed
    No further data may be exchanged in this state
    This signifies that the connection is closing gracefully
    Only PacketDisconnectUnderstood may be received in this state
    This defines the state where only the initialization protocol is active
    App-defined packets cannot be transferred in this state
    This defines the state where apps can run their own initialization tasks
    Only App-defined packets that implement InitialPacket should sent in this state
    This defines the state before any packets have successfully been received
    Only InitPacketDeclaration may be received in this state
    This defines the state where the app-defined protocol is active and ready for use
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Get this step as an Integer
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • PRE_INITIALIZATION

      public static final ConnectionState PRE_INITIALIZATION
      This defines the state before any packets have successfully been received
      Only InitPacketDeclaration may be received in this state
    • INITIALIZATION

      public static final ConnectionState INITIALIZATION
      This defines the state where only the initialization protocol is active
      App-defined packets cannot be transferred in this state
    • POST_INITIALIZATION

      public static final ConnectionState POST_INITIALIZATION
      This defines the state where apps can run their own initialization tasks
      Only App-defined packets that implement InitialPacket should sent in this state
    • READY

      public static final ConnectionState READY
      This defines the state where the app-defined protocol is active and ready for use
    • CLOSING

      public static final ConnectionState CLOSING
      This signifies that the connection is closing gracefully
      Only PacketDisconnectUnderstood may be received in this state
    • CLOSED

      public static final ConnectionState CLOSED
      This means that the connection is closed
      No further data may be exchanged in this state
  • Method Details

    • values

      public static ConnectionState[] 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 ConnectionState 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
    • asInt

      public int asInt()
      Get this step as an Integer
      Returns:
      Integer value