Package org.apache.curator.framework.recipes.cache

Enum TreeCacheEvent.Type

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TreeCacheEvent.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TreeCacheEvent.Type[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NODE_REMOVED

        public static final TreeCacheEvent.Type NODE_REMOVED
        A node was removed from the tree

      • CONNECTION_SUSPENDED

        public static final TreeCacheEvent.Type CONNECTION_SUSPENDED
        Called when the connection has changed to ConnectionState.SUSPENDED

        This is exposed so that users of the class can be notified of issues that *might* affect normal operation. The TreeCache is written such that listeners are not expected to do anything special on this event, except for those people who want to cause some application-specific logic to fire when this occurs. While the connection is down, the TreeCache will continue to have its state from before it lost the connection and after the connection is restored, the TreeCache will emit normal child events for all of the adds, deletes and updates that happened during the time that it was disconnected.

      • CONNECTION_RECONNECTED

        public static final TreeCacheEvent.Type CONNECTION_RECONNECTED
        Called when the connection has changed to ConnectionState.RECONNECTED

        This is exposed so that users of the class can be notified of issues that *might* affect normal operation. The TreeCache is written such that listeners are not expected to do anything special on this event, except for those people who want to cause some application-specific logic to fire when this occurs. While the connection is down, the TreeCache will continue to have its state from before it lost the connection and after the connection is restored, the TreeCache will emit normal child events for all of the adds, deletes and updates that happened during the time that it was disconnected.

        After reconnection, the cache will resynchronize its internal state with the server, then fire a INITIALIZED event.

      • CONNECTION_LOST

        public static final TreeCacheEvent.Type CONNECTION_LOST
        Called when the connection has changed to ConnectionState.LOST

        This is exposed so that users of the class can be notified of issues that *might* affect normal operation. The TreeCache is written such that listeners are not expected to do anything special on this event, except for those people who want to cause some application-specific logic to fire when this occurs. While the connection is down, the TreeCache will continue to have its state from before it lost the connection and after the connection is restored, the TreeCache will emit normal child events for all of the adds, deletes and updates that happened during the time that it was disconnected.

      • INITIALIZED

        public static final TreeCacheEvent.Type INITIALIZED
        Posted after the initial cache has been fully populated.

        On startup, the cache synchronizes its internal state with the server, publishing a series of NODE_ADDED events as new nodes are discovered. Once the cachehas been fully synchronized, this INITIALIZED this event is published. All events published after this event represent actual server-side mutations.

        On reconnection, the cache will resynchronize its internal state with the server, and fire this event again once its internal state is completely refreshed.

        Note: because the initial population is inherently asynchronous, so it's possible to observe server-side changes (such as a NODE_UPDATED) prior to this event being published.

    • Method Detail

      • values

        public static TreeCacheEvent.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (TreeCacheEvent.Type c : TreeCacheEvent.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TreeCacheEvent.Type 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