Enum DocumentStoreException.Type

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      GENERIC
      A generic type of DocumentStoreException.
      TRANSIENT
      A DocumentStoreException caused by a transient problem.
    • Method Summary

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

      • GENERIC

        public static final DocumentStoreException.Type GENERIC
        A generic type of DocumentStoreException. This type is used when no explicit type is given when a DocumentStoreException is constructed.
      • TRANSIENT

        public static final DocumentStoreException.Type TRANSIENT
        A DocumentStoreException caused by a transient problem. E.g. a network issue. This type of exception indicates a future invocation of the same operation may succeed if the underlying problem gets resolved.
    • Method Detail

      • values

        public static DocumentStoreException.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 (DocumentStoreException.Type c : DocumentStoreException.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 DocumentStoreException.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