Package org.simpleframework.common.thread

Class Daemon

  • All Implemented Interfaces:
    java.lang.Runnable
    public abstract class Daemon
extends java.lang.Object
implements java.lang.Runnable
    The Daemon object provides a named thread which will execute the run method when started. This offers some convenience in that it hides the normal thread methods and also allows the object extending this to provide the name of the internal thread, which is given an incrementing sequence number appended to the name provided.
    Author:
    Niall Gallagher

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Daemon()
      Constructor for the Daemon object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void interrupt()
      This is used to interrupt the internal thread.
      boolean isActive()
      This is used to determine if the runner is active.
      void start()
      This is used to start the internal thread.
      void stop()
      This method is used to stop the thread without forcing it to stop.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.lang.Runnable

        run

    • Constructor Detail

      • Daemon

        protected Daemon()
        Constructor for the Daemon object. This will create the internal thread and ensure it is a daemon. When it is started the name of the internal thread is set using the name of the instance as taken from getName. If the name provided is null then no name is set for the thread.

    • Method Detail

      • isActive

        public boolean isActive()
        This is used to determine if the runner is active. If it is not active then it is assumed that no thread is executing. Also, if this is extended then any executing thread to stop as soon as this method returns false.
        Returns:
        this returns true if the runner is active

      • start

        public void start()
        This is used to start the internal thread. Once started the internal thread will execute the run method of this instance. Aside from starting the thread this will also ensure the internal thread has a unique name.

      • interrupt

        public void interrupt()
        This is used to interrupt the internal thread. This is used when there is a need to wake the thread from a sleeping or waiting state so that some other operation can be performed. Typically this is required when killing the thread.

      • stop

        public void stop()
        This method is used to stop the thread without forcing it to stop. It acts as a means to deactivate it. It is up to the implementor to ensure that the isActive method is checked to determine whether it should continue to run.