From 258d5d490625f65bb683c3c2d453c0dee33cf6c3 Mon Sep 17 00:00:00 2001 From: kohsuke Date: Sun, 17 Dec 2006 18:01:17 +0000 Subject: [PATCH] doc improvement. git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@1359 71c3de6d-444a-0410-be80-ed276b4c234a --- core/src/main/java/hudson/FeedAdapter.java | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/core/src/main/java/hudson/FeedAdapter.java b/core/src/main/java/hudson/FeedAdapter.java index 49baf94320..3772fe0b58 100644 --- a/core/src/main/java/hudson/FeedAdapter.java +++ b/core/src/main/java/hudson/FeedAdapter.java @@ -8,8 +8,26 @@ import java.util.Calendar; * @author Kohsuke Kawaguchi */ public interface FeedAdapter { + /** + * 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); }