KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > cruisecontrol > publishers > rss > CruiseControlFeed


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2005, 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.rss;
38
39 import java.io.File JavaDoc;
40
41 /**
42  * The CruiseControlFeed class extends the generic Feed class with
43  * CruiseControl-specific functionality. Specifically, the CruiseControlFeed
44  * class keeps track of how many projects are being published into the feed
45  * and uses this information to generate a default feed title and description.
46  *
47  * Copyright (c) 2005 Hewlett-Packard Development Company, L.P.
48  * @author Patrick Conant
49  */
50 public class CruiseControlFeed extends Feed {
51
52     /**
53      * Project count indicates how many CC projects are using this feed.
54      * This affects the link URL, title and description of the feed.
55      */
56     private int projectCount;
57
58     private String JavaDoc projectName;
59
60     /**
61      * Constructor.
62      */
63     public CruiseControlFeed(File JavaDoc publishToFile) {
64         super(publishToFile);
65     }
66
67     /**
68      * incrementProjectCount is called by the RSSPublisher when a new project
69      * is feeding into this Feed instance.
70      */
71     public void incrementProjectCount() {
72         this.projectCount++;
73     }
74
75     /**
76      * getProjectCount is a convenience method used internally to determine
77      * whether multiple projects are publishing into the same feed.
78      */
79     public int getProjectCount() {
80         return this.projectCount;
81     }
82
83     /**
84      * Set the name of the project being published into this feed.
85      */
86     public void setProjectName(String JavaDoc name) {
87         if (isNotEmpty(this.projectName)) {
88             this.projectName = this.projectName + ", " + name;
89         } else {
90             this.projectName = name;
91         }
92     }
93
94     /**
95      * Return the name of the project(s) that are publishing into this feed.
96      */
97     public String JavaDoc getProjectName() {
98         return this.projectName;
99     }
100
101     /**
102      * Generate a description of this feed based on the names of the projects
103      * flowing into the feed. This method over-rides the base Feed class'
104      * getDescription() method.
105      */
106     public String JavaDoc getDescription() {
107         if (isNotEmpty(super.getDescription())) {
108             return super.getDescription();
109         } else if (isNotEmpty(this.projectName)) {
110             return "Automated build results for CruiseControl project(s) " + this.projectName;
111         } else {
112             return "Automated build results for CruiseControl.";
113         }
114     }
115
116     /**
117      * Generate a title of this feed based on the names of the projects
118      * flowing into the feed.This method over-rides the base Feed class'
119      * getTitle() method.
120      */
121     public String JavaDoc getTitle() {
122         if (isNotEmpty(super.getTitle())) {
123             return super.getTitle();
124         } else {
125             return "CruiseControl Build Results";
126         }
127     }
128
129     private static boolean isNotEmpty(String JavaDoc string) {
130         return string != null && string.trim().length() > 0;
131     }
132 }
133
134
135
136
Popular Tags