org.springframework.boot.web.server

Enum Shutdown

  • java.lang.Object
    • java.lang.Enum<Shutdown>
      • org.springframework.boot.web.server.Shutdown
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Shutdown>


    public enum Shutdown
    extends java.lang.Enum<Shutdown>
    Configuration for shutting down a WebServer.
    Since:
    2.3.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      GRACEFUL
      The WebServer should support graceful shutdown, allowing active requests time to complete.
      IMMEDIATE
      The WebServer should shut down immediately.
    • Method Summary

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

      • GRACEFUL

        public static final Shutdown GRACEFUL
        The WebServer should support graceful shutdown, allowing active requests time to complete.
      • IMMEDIATE

        public static final Shutdown IMMEDIATE
        The WebServer should shut down immediately.
    • Method Detail

      • values

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

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