Enum ConnectionEvent

java.lang.Object
java.lang.Enum<ConnectionEvent>
io.ably.lib.realtime.ConnectionEvent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ConnectionEvent>, java.lang.constant.Constable

public enum ConnectionEvent
extends java.lang.Enum<ConnectionEvent>
Describes the events emitted by a Connection object. An event is either an UPDATE or a ConnectionState.
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    closed  
    closing  
    connected  
    connecting  
    disconnected  
    failed  
    initialized  
    suspended  
    update
    An event for changes to connection conditions for which the ConnectionState does not change.
  • Method Summary

    Modifier and Type Method Description
    static ConnectionEvent valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static ConnectionEvent[] values()
    Returns an array containing the constants of this enum type, 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

  • Method Details

    • values

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

      public static ConnectionEvent valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null