Source for org.jfree.report.util.WorkerHandle

   1: /**
   2:  * ========================================
   3:  * JFreeReport : a free Java report library
   4:  * ========================================
   5:  *
   6:  * Project Info:  http://reporting.pentaho.org/
   7:  *
   8:  * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
   9:  *
  10:  * This library is free software; you can redistribute it and/or modify it under the terms
  11:  * of the GNU Lesser General Public License as published by the Free Software Foundation;
  12:  * either version 2.1 of the License, or (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  15:  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16:  * See the GNU Lesser General Public License for more details.
  17:  *
  18:  * You should have received a copy of the GNU Lesser General Public License along with this
  19:  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20:  * Boston, MA 02111-1307, USA.
  21:  *
  22:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  23:  * in the United States and other countries.]
  24:  *
  25:  * ------------
  26:  * $Id: WorkerHandle.java 2725 2007-04-01 18:49:29Z taqua $
  27:  * ------------
  28:  * (C) Copyright 2000-2005, by Object Refinery Limited.
  29:  * (C) Copyright 2005-2007, by Pentaho Corporation.
  30:  */
  31: 
  32: package org.jfree.report.util;
  33: 
  34: /**
  35:  * The worker handle is a control structure which allows control over the worker without
  36:  * exposing the thread object.
  37:  *
  38:  * @author Thomas Morgner
  39:  */
  40: public class WorkerHandle
  41: {
  42:   /**
  43:    * The worker for this handle.
  44:    */
  45:   private final Worker worker;
  46: 
  47:   /**
  48:    * Creates a new handle for the given worker.
  49:    *
  50:    * @param worker the worker.
  51:    */
  52:   public WorkerHandle (final Worker worker)
  53:   {
  54:     this.worker = worker;
  55:   }
  56: 
  57:   /**
  58:    * Finishes the worker.
  59:    */
  60:   public void finish ()
  61:   {
  62:     worker.finish();
  63:   }
  64: }