reintroduced StringUtil.regexpReplace
[mir.git] / source / mir / producer / NodedProducer.java
1 /*
2  * Copyright (C) 2001-2006 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License,
22  * and distribute linked combinations including the two.  You must obey the
23  * GNU General Public License in all respects for all of the code used other than
24  * the above mentioned libraries.  If you modify this file, you may extend this
25  * exception to your version of the file, but you are not obligated to do so.
26  * If you do not wish to do so, delete this exception statement from your version.
27  */
28 package mir.producer;
29
30 /**
31  * <p>A NodedProducer is the root of a tree of ProducerNodes.</p>
32  * 
33  * <p>There  used to be  a time  when there  were Producers  that weren't
34  * NodedProducers, however they have been phased out.</p>
35  */
36
37 public class NodedProducer implements Producer {
38   private ProducerNode rootNode;
39   private boolean isAborted;
40   private boolean isFinished;
41   protected final static String PRODUCER_KEY = "$producer";
42
43   public NodedProducer(ProducerNode aRootNode) {
44     rootNode = aRootNode;
45     isAborted = false;
46   }
47
48   public boolean execute(ProductionContext aProductionContext) throws ProducerFailure, ProducerExc {
49     rootNode.produce(aProductionContext);
50
51     synchronized(this) {
52       isFinished=true;
53
54       return !isAborted;
55     }
56   }
57
58   public void abort(ProductionContext aContext) {
59     synchronized(this) {
60       if (!isFinished)
61         isAborted=true;
62     }
63   }
64
65   public boolean getIsAborted() {
66     synchronized(this) {
67       return isAborted;
68     }
69   }
70 }