KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > cruisecontrol > publishers > ConditionalPublisher


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2001, ThoughtWorks, Inc.
4  * 651 W Washington Ave. Suite 600
5  * Chicago, IL 60661 USA
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * + Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * + Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  *
20  * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
21  * names of its contributors may be used to endorse or promote
22  * products derived from this software without specific prior
23  * written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  ********************************************************************************/
37 package net.sourceforge.cruisecontrol.publishers;
38
39 import java.util.ArrayList JavaDoc;
40 import java.util.Iterator JavaDoc;
41 import java.util.List JavaDoc;
42
43 import org.jdom.Element;
44
45 import net.sourceforge.cruisecontrol.CruiseControlException;
46 import net.sourceforge.cruisecontrol.Publisher;
47 import net.sourceforge.cruisecontrol.util.ValidationHelper;
48
49 /**
50  * An abstract base class for any publisher which wishes to conditionally
51  * execute a set of contained <coe>Publisher</code>s.
52  */
53 public abstract class ConditionalPublisher implements Publisher {
54
55     private List JavaDoc publishers = new ArrayList JavaDoc();
56
57     public void publish(Element log) throws CruiseControlException {
58         if (shouldPublish(log)) {
59             for (Iterator JavaDoc iterator = publishers.iterator(); iterator.hasNext();) {
60                 Publisher publisher = (Publisher) iterator.next();
61                 publisher.publish(log);
62             }
63         }
64     }
65
66     public void validate() throws CruiseControlException {
67         ValidationHelper.assertTrue(publishers.size() > 0,
68             "conditional publishers should have at least one nested publisher");
69
70         for (Iterator JavaDoc iterator = publishers.iterator(); iterator.hasNext();) {
71             Publisher publisher = (Publisher) iterator.next();
72             publisher.validate();
73         }
74     }
75
76     /**
77      * Adds a nested publisher
78      *
79      * @param publisher The publisher to add
80      */
81     public void add(Publisher publisher) {
82         publishers.add(publisher);
83     }
84
85     /**
86      * Determines if the nested publishers should be executed. This method must
87      * be implemented by all derrived classes.
88      *
89      * @param log
90      * The build log
91      * @return <code>true</code> if the nested publishers should be executed,
92      * <code>false</code> otherwise
93      */
94     public abstract boolean shouldPublish(Element log);
95 }
Popular Tags