/* 
    P/P   *  Method: com.dmdirc.util.ReturnableThread__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.util;
    24  
    25  /**
    26   * Normal thread with the potential to return a value.
    27   * 
    28   * @param T Type to be returned
    29   */
         /* 
    P/P   *  Method: void com.dmdirc.util.ReturnableThread()
          */
    30  public abstract class ReturnableThread<T> extends Thread {
    31  
    32      /** Returnable object. */
    33      private T value;
    34  
    35      /** {@inheritDoc} */
    36      @Override
    37      public abstract void run();
    38  
    39      /**
    40       * Sets the returnable object.
    41       * 
    42       * @param value new returnable object
    43       */
    44      public void setObject(final T value) {
                 /* 
    P/P           *  Method: void setObject(Object)
                  * 
                  *  Postconditions:
                  *    this.value == value
                  *    init'ed(this.value)
                  */
    45          this.value = value;
    46      }
    47  
    48      /**
    49       * Returns the object set by this thread.
    50       * 
    51       * @return Returnable object
    52       */
    53      public T getObject() {
                 /* 
    P/P           *  Method: Object getObject()
                  * 
                  *  Preconditions:
                  *    init'ed(this.value)
                  * 
                  *  Postconditions:
                  *    return_value == this.value
                  *    init'ed(return_value)
                  */
    54          return value;
    55      }
    56  }