Interface ScopedPersistentState


  • public interface ScopedPersistentState
    ScopedPersistentState represents state which needs to be persisted, scoped by name (e.g. the cache name). The default implementation of persistent state uses the standard Properties format with the additional rule that order is preserved. In order to verify state consistency (e.g. across a cluster) a checksum of the state's data can be computed. State properties prefixed with the '@' character will not be included as part of the checksum computation (e.g. @timestamp)
    Since:
    8.1
    Author:
    Tristan Tarrant
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String GLOBAL_SCOPE  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean containsProperty​(java.lang.String key)
      Returns whether the state contains a property
      void forEach​(java.util.function.BiConsumer<java.lang.String,​java.lang.String> action)
      Performs the specified action on every entry of the state
      int getChecksum()
      Returns the checksum of the properties excluding those prefixed with @
      float getFloatProperty​(java.lang.String key)
      Retrieves a float state property
      int getIntProperty​(java.lang.String key)
      Retrieves an integer state property
      java.lang.String getProperty​(java.lang.String key)
      Retrieves a state property
      java.lang.String getScope()
      Returns the name of this persistent state's scope
      void setProperty​(java.lang.String format, float f)
      Sets a float state property.
      void setProperty​(java.lang.String key, int value)
      Sets an integer state property.
      void setProperty​(java.lang.String key, java.lang.String value)
      Sets a state property.
    • Method Detail

      • getScope

        java.lang.String getScope()
        Returns the name of this persistent state's scope
      • setProperty

        void setProperty​(java.lang.String key,
                         java.lang.String value)
        Sets a state property. Values will be unicode-escaped when written
      • getProperty

        java.lang.String getProperty​(java.lang.String key)
        Retrieves a state property
      • setProperty

        void setProperty​(java.lang.String key,
                         int value)
        Sets an integer state property.
      • setProperty

        void setProperty​(java.lang.String format,
                         float f)
        Sets a float state property.
      • getIntProperty

        int getIntProperty​(java.lang.String key)
        Retrieves an integer state property
      • getFloatProperty

        float getFloatProperty​(java.lang.String key)
        Retrieves a float state property
      • forEach

        void forEach​(java.util.function.BiConsumer<java.lang.String,​java.lang.String> action)
        Performs the specified action on every entry of the state
      • getChecksum

        int getChecksum()
        Returns the checksum of the properties excluding those prefixed with @
      • containsProperty

        boolean containsProperty​(java.lang.String key)
        Returns whether the state contains a property