View Javadoc

1   package com.sun.syndication.fetcher;
2   
3   import java.util.EventObject;
4   
5   import com.sun.syndication.feed.synd.SyndFeed;
6   
7   /***
8    * Implementation note: FetcherEvent is not thread safe. Make sure that
9    * they are only ever accessed by one thread. If necessary, make all getters
10   * and setters synchronized, or alternatively make all fields final.
11   * 
12   * @author nl
13   */
14  public class FetcherEvent extends EventObject {
15  
16  	private static final long serialVersionUID = 3985600601904140103L;
17  
18  	public static final String EVENT_TYPE_FEED_POLLED = "FEED_POLLED";
19  	public static final String EVENT_TYPE_FEED_RETRIEVED = "FEED_RETRIEVED";
20  	public static final String EVENT_TYPE_FEED_UNCHANGED = "FEED_UNCHANGED";
21  	
22  	private String eventType;
23  	private String urlString;
24  	private SyndFeed feed;
25      
26  	public FetcherEvent(Object source) {
27  		super(source);
28  	}
29  
30  
31  	public FetcherEvent(Object source, String urlStr, String eventType) {
32  		this(source);
33  		setUrlString(urlStr);
34  		setEventType(eventType);
35  	}	
36  
37  	public FetcherEvent(Object source, String urlStr, String eventType, SyndFeed feed) {
38  		this(source, urlStr, eventType);
39  		setFeed(feed);
40  	}	
41  	
42  	
43      /***
44       * @return Returns the feed.
45       * 
46       * <p>The feed will only be set if the eventType is EVENT_TYPE_FEED_RETRIEVED</p>
47       */
48      public SyndFeed getFeed() {
49          return feed;
50      }
51      
52      /***
53       * @param feed The feed to set.
54       * 
55       * <p>The feed will only be set if the eventType is EVENT_TYPE_FEED_RETRIEVED</p>
56       */
57      public void setFeed(SyndFeed feed) {
58          this.feed = feed;
59      }
60  	
61  	/***
62  	 * @return Returns the eventType.
63  	 */
64  	public String getEventType() {
65  		return eventType;
66  	}
67  	/***
68  	 * @param eventType The eventType to set.
69  	 */
70  	public void setEventType(String eventType) {
71  		this.eventType = eventType;
72  	}
73  	/***
74  	 * @return Returns the urlString.
75  	 */
76  	public String getUrlString() {
77  		return urlString;
78  	}
79  	/***
80  	 * @param urlString The urlString to set.
81  	 */
82  	public void setUrlString(String urlString) {
83  		this.urlString = urlString;
84  	}
85  }