Enum CacheDeserializedValues

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

    public enum CacheDeserializedValues
    extends java.lang.Enum<CacheDeserializedValues>
    Control caching of de-serialized values. Caching makes query evaluation faster but it costs memory. To maintain reusability, cached values are used by read-only operations only and they are never passed to user-code where they could be accidentally mutated. Users will always get a fresh object, which they are free to mutate. It does not have any effect when Portable serialization or InMemoryFormat.OBJECT format is used.
    Since:
    3.6
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      Always cache de-serialized values
      INDEX_ONLY
      Cache values only when using search indexes
      NEVER
      Never cache de-serialized value
    • Method Summary

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

      • values

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

        public static CacheDeserializedValues 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
      • parseString

        public static CacheDeserializedValues parseString​(java.lang.String string)
        Create instance from String
        Parameters:
        string - the string value to parse
        Returns:
        instance of CacheDeserializedValues
        Throws:
        java.lang.IllegalArgumentException - when unknown value is passed