Package org.apache.commons.lang3.concurrent

Class BasicThreadFactory.Builder

  • All Implemented Interfaces:
    Builder<BasicThreadFactory>
    Enclosing class:
    BasicThreadFactory
    public static class BasicThreadFactory.Builder
extends java.lang.Object
implements Builder<BasicThreadFactory>

    A builder class for creating instances of BasicThreadFactory.

    Using this builder class instances of BasicThreadFactory can be created and initialized. The class provides methods that correspond to the configuration options supported by BasicThreadFactory. Method chaining is supported. Refer to the documentation of BasicThreadFactory for a usage example.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Boolean daemon
      The daemon flag.
      private java.lang.Thread.UncaughtExceptionHandler exceptionHandler
      The uncaught exception handler.
      private java.lang.String namingPattern
      The naming pattern.
      private java.lang.Integer priority
      The priority.
      private java.util.concurrent.ThreadFactory wrappedFactory
      The wrapped factory.

    • Constructor Summary

      Constructors 
      Constructor Description
      Builder()  

    • Field Detail

      • wrappedFactory

        private java.util.concurrent.ThreadFactory wrappedFactory
        The wrapped factory.

      • exceptionHandler

        private java.lang.Thread.UncaughtExceptionHandler exceptionHandler
        The uncaught exception handler.

      • namingPattern

        private java.lang.String namingPattern
        The naming pattern.

      • priority

        private java.lang.Integer priority
        The priority.

      • daemon

        private java.lang.Boolean daemon
        The daemon flag.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • wrappedFactory

        public BasicThreadFactory.Builder wrappedFactory​(java.util.concurrent.ThreadFactory factory)
        Sets the ThreadFactory to be wrapped by the new BasicThreadFactory.
        Parameters:
        factory - the wrapped ThreadFactory (must not be null)
        Returns:
        a reference to this Builder
        Throws:
        java.lang.NullPointerException - if the passed in ThreadFactory is null

      • namingPattern

        public BasicThreadFactory.Builder namingPattern​(java.lang.String pattern)
        Sets the naming pattern to be used by the new BasicThreadFactory.
        Parameters:
        pattern - the naming pattern (must not be null)
        Returns:
        a reference to this Builder
        Throws:
        java.lang.NullPointerException - if the naming pattern is null

      • daemon

        public BasicThreadFactory.Builder daemon​(boolean daemon)
        Sets the daemon flag for the new BasicThreadFactory. If this flag is set to true the new thread factory will create daemon threads.
        Parameters:
        daemon - the value of the daemon flag
        Returns:
        a reference to this Builder

      • priority

        public BasicThreadFactory.Builder priority​(int priority)
        Sets the priority for the threads created by the new BasicThreadFactory.
        Parameters:
        priority - the priority
        Returns:
        a reference to this Builder

      • uncaughtExceptionHandler

        public BasicThreadFactory.Builder uncaughtExceptionHandler​(java.lang.Thread.UncaughtExceptionHandler handler)
        Sets the uncaught exception handler for the threads created by the new BasicThreadFactory.
        Parameters:
        handler - the UncaughtExceptionHandler (must not be null)
        Returns:
        a reference to this Builder
        Throws:
        java.lang.NullPointerException - if the exception handler is null

      • reset

        public void reset()
        Resets this builder. All configuration options are set to default values. Note: If the build() method was called, it is not necessary to call reset() explicitly because this is done automatically.

      • build

        public BasicThreadFactory build()
        Creates a new BasicThreadFactory with all configuration options that have been specified by calling methods on this builder. After creating the factory reset() is called.
        Specified by:
        build in interface Builder<BasicThreadFactory>
        Returns:
        the new BasicThreadFactory