doc improvement.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@1359 71c3de6d-444a-0410-be80-ed276b4c234a
This commit is contained in:
kohsuke committed 2006-12-17 18:01:17 +00:00
1 parent 2472b1d8fc
commit 258d5d4906
1 file changed
+18
@@ -8,8 +8,26 @@ import java.util.Calendar;
* @author Kohsuke Kawaguchi
*/
public interface FeedAdapter<E> {
/**
* Gets the human readable title of the entry.
* In RSS readers, this is usually displayed like an e-mail subject.
*/
String getEntryTitle(E entry);
/**
* Gets the URL that represents this entry.
* Relative to context root of the Hudson.
*/
String getEntryUrl(E entry);
/**
* Unique ID of each entry.
* RSS readers use this to determine what feeds are new and what are not.
*/
String getEntryID(E entry);
/**
* Timestamp of the last change in ithis entry.
*/
Calendar getEntryTimestamp(E entry);
}