Enum StreamScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StreamScope>

    public enum StreamScope
    extends java.lang.Enum<StreamScope>
    Determines the scope of a stream's durability, if any.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DURABLE
      All messages are stored in TimeBase
      EXTERNAL_FILE
      All messages are stored in external data file.
      RUNTIME
      The stream does not leave any permanent trace
      TRANSIENT
      The stream does not store data on disk, but its key and structure are durable.
    • Method Summary

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

      • DURABLE

        public static final StreamScope DURABLE
        All messages are stored in TimeBase
      • EXTERNAL_FILE

        public static final StreamScope EXTERNAL_FILE
        All messages are stored in external data file.
      • TRANSIENT

        public static final StreamScope TRANSIENT
        The stream does not store data on disk, but its key and structure are durable.
      • RUNTIME

        public static final StreamScope RUNTIME
        The stream does not leave any permanent trace
    • Method Detail

      • values

        public static StreamScope[] 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 (StreamScope c : StreamScope.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static StreamScope 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