net.sourceforge.cruisecontrol.publishers.rss
Class CruiseControlFeed

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.publishers.rss.Feed
      extended bynet.sourceforge.cruisecontrol.publishers.rss.CruiseControlFeed

public class CruiseControlFeed
extends Feed

The CruiseControlFeed class extends the generic Feed class with CruiseControl-specific functionality. Specifically, the CruiseControlFeed class keeps track of how many projects are being published into the feed and uses this information to generate a default feed title and description. Copyright (c) 2005 Hewlett-Packard Development Company, L.P.

Author:
Patrick Conant

Constructor Summary
CruiseControlFeed(java.io.File publishToFile)
          Constructor.
 
Method Summary
 java.lang.String getDescription()
          Generate a description of this feed based on the names of the projects flowing into the feed.
 int getProjectCount()
          getProjectCount is a convenience method used internally to determine whether multiple projects are publishing into the same feed.
 java.lang.String getProjectName()
          Return the name of the project(s) that are publishing into this feed.
 java.lang.String getTitle()
          Generate a title of this feed based on the names of the projects flowing into the feed.This method over-rides the base Feed class' getTitle() method.
 void incrementProjectCount()
          incrementProjectCount is called by the RSSPublisher when a new project is feeding into this Feed instance.
 void setProjectName(java.lang.String name)
          Set the name of the project being published into this feed.
 
Methods inherited from class net.sourceforge.cruisecontrol.publishers.rss.Feed
addItem, getItems, getLink, getMaxLength, setDescription, setLink, setMaxLength, setTitle, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CruiseControlFeed

public CruiseControlFeed(java.io.File publishToFile)
Constructor.

Method Detail

incrementProjectCount

public void incrementProjectCount()
incrementProjectCount is called by the RSSPublisher when a new project is feeding into this Feed instance.


getProjectCount

public int getProjectCount()
getProjectCount is a convenience method used internally to determine whether multiple projects are publishing into the same feed.


setProjectName

public void setProjectName(java.lang.String name)
Set the name of the project being published into this feed.


getProjectName

public java.lang.String getProjectName()
Return the name of the project(s) that are publishing into this feed.


getDescription

public java.lang.String getDescription()
Generate a description of this feed based on the names of the projects flowing into the feed. This method over-rides the base Feed class' getDescription() method.

Overrides:
getDescription in class Feed

getTitle

public java.lang.String getTitle()
Generate a title of this feed based on the names of the projects flowing into the feed.This method over-rides the base Feed class' getTitle() method.

Overrides:
getTitle in class Feed
Returns:
title the title of the RSS feed.