Package io.microsphere.util

Class ShutdownHookUtils

  • All Implemented Interfaces:
    Utils
    public abstract class ShutdownHookUtils
extends java.lang.Object
implements Utils
    The utilities class for ShutdownHook
    Since:
    1.0.0
    Author:
    Mercy
    See Also:
    java.lang.ApplicationShutdownHooks

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean addShutdownHookCallback​(java.lang.Runnable callback)
      Add the Shutdown Hook Callback
      static java.util.Set<java.lang.Thread> filterShutdownHookThreads​(java.util.function.Predicate<? super java.lang.Thread> hookThreadFilter)  
      static java.util.Set<java.lang.Thread> filterShutdownHookThreads​(java.util.function.Predicate<? super java.lang.Thread> hookThreadFilter, boolean removed)  
      static java.util.Queue<java.lang.Runnable> getShutdownHookCallbacks()
      Get all Shutdown Hook Callbacks
      static java.util.Set<java.lang.Thread> getShutdownHookThreads()
      Get the shutdown hooks' threads that was added
      static void registerShutdownHook()
      Register the ShutdownHookCallbacksThread as the shutdown hook
      static boolean removeShutdownHookCallback​(java.lang.Runnable callback)
      Remove the Shutdown Hook Callback

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • SHUTDOWN_HOOK_CALLBACKS_CAPACITY_PROPERTY_NAME

        public static final java.lang.String SHUTDOWN_HOOK_CALLBACKS_CAPACITY_PROPERTY_NAME
        The System property name of the capacity of ShutdownHook callbacks
        See Also:
        Constant Field Values

      • SHUTDOWN_HOOK_CALLBACKS_CAPACITY

        public static final int SHUTDOWN_HOOK_CALLBACKS_CAPACITY
        The System property value of the capacity of ShutdownHook callbacks, the default value is 512

      • SHUTDOWN_HOOK_CALLBACKS_THREAD_FILTER

        public static final java.util.function.Predicate<? super java.lang.Thread> SHUTDOWN_HOOK_CALLBACKS_THREAD_FILTER
        The Predicate to filter the type that is ShutdownHookCallbacksThread

    • Method Detail

      • registerShutdownHook

        public static void registerShutdownHook()
        Register the ShutdownHookCallbacksThread as the shutdown hook
        See Also:
        ShutdownHookCallbacksThread

      • getShutdownHookThreads

        public static java.util.Set<java.lang.Thread> getShutdownHookThreads()
        Get the shutdown hooks' threads that was added
        Returns:
        non-null

      • filterShutdownHookThreads

        public static java.util.Set<java.lang.Thread> filterShutdownHookThreads​(java.util.function.Predicate<? super java.lang.Thread> hookThreadFilter)

      • filterShutdownHookThreads

        public static java.util.Set<java.lang.Thread> filterShutdownHookThreads​(java.util.function.Predicate<? super java.lang.Thread> hookThreadFilter,
                                                                        boolean removed)

      • addShutdownHookCallback

        public static boolean addShutdownHookCallback​(java.lang.Runnable callback)
        Add the Shutdown Hook Callback
        Parameters:
        callback - the Runnable callback
        Returns:
        true if the specified Shutdown Hook Callback added, otherwise false

      • removeShutdownHookCallback

        public static boolean removeShutdownHookCallback​(java.lang.Runnable callback)
        Remove the Shutdown Hook Callback
        Parameters:
        callback - the Runnable callback
        Returns:
        true if the specified Shutdown Hook Callback removed, otherwise false

      • getShutdownHookCallbacks

        public static java.util.Queue<java.lang.Runnable> getShutdownHookCallbacks()
        Get all Shutdown Hook Callbacks
        Returns:
        non-null