Enum InterceptPhase

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

    public enum InterceptPhase
    extends java.lang.Enum<InterceptPhase>

    Interceptor classes implement the Ordered interface in order to control the order of execution when multiple interceptors are present.

    This class provides a set of common constants for typical phases used by interceptors thus making it easier to position an interceptor in the correct phase.

    Since:
    1.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ASYNC
      Async phase of execution.
      CACHE
      Caching phase of execution.
      RETRY
      Retry phase of execution.
      TRACE
      Trace phase of execution.
      TRANSACTION
      Transaction phase of execution.
      VALIDATE
      Validation phase of execution.
    • Method Summary

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

      • VALIDATE

        public static final InterceptPhase VALIDATE
        Validation phase of execution.
      • CACHE

        public static final InterceptPhase CACHE
        Caching phase of execution.
      • TRACE

        public static final InterceptPhase TRACE
        Trace phase of execution.
      • RETRY

        public static final InterceptPhase RETRY
        Retry phase of execution.
      • ASYNC

        public static final InterceptPhase ASYNC
        Async phase of execution.
      • TRANSACTION

        public static final InterceptPhase TRANSACTION
        Transaction phase of execution.
    • Method Detail

      • values

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

        public static InterceptPhase 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
      • getPosition

        public int getPosition()
        Returns:
        The position