com.atlassian.confluence.rss
Interface FeedBuilder

All Known Implementing Classes:

DefaultFeedBuilder

public interface FeedBuilder

Builds a feed.

Method Summary

com.sun.syndication.feed.synd.SyndFeed	createFeed(ISearch search, FeedProperties feedProperties) Constructs a feed off the specified search.
com.sun.syndication.feed.synd.SyndFeed	createFeed(ListQuery query, boolean showContent, boolean showDiff, com.atlassian.user.User user) Deprecated. since 4.0. The showDiffParameter is ignored. Use createFeed(ListQuery, FeedProperties).
com.sun.syndication.feed.synd.SyndFeed	createFeed(ListQuery query, FeedProperties feedProperties) Constructs a feed after running a search based on the given query.
com.sun.syndication.feed.synd.SyndFeed	createPublicFeed(ListQuery query, boolean showContent, boolean showDiff) Deprecated. since 3.0. Use createFeed(com.atlassian.confluence.search.v2.ISearch, FeedProperties) instead. Public feed can be indicated in FeedProperties.

Method Detail

createPublicFeed

@Deprecated
com.sun.syndication.feed.synd.SyndFeed createPublicFeed(ListQuery query,
                                                                   boolean showContent,
                                                                   boolean showDiff)

Deprecated. since 3.0. Use createFeed(com.atlassian.confluence.search.v2.ISearch, FeedProperties) instead. Public feed can be indicated in FeedProperties.

createFeed

@Deprecated
com.sun.syndication.feed.synd.SyndFeed createFeed(ListQuery query,
                                                             boolean showContent,
                                                             boolean showDiff,
                                                             com.atlassian.user.User user)

Deprecated. since 4.0. The showDiffParameter is ignored. Use createFeed(ListQuery, FeedProperties).

Constructs a feed after running a search based on the given query. This method can be used instead of createFeed(ISearch, FeedProperties) when it is impossible to create a corresponding ISearch object from the given ListQuery. Eg. when search results need to be further filtered to satisfy a query. see CONF-7745 and CONF-9312

createFeed

com.sun.syndication.feed.synd.SyndFeed createFeed(ISearch search,
                                                  FeedProperties feedProperties)

Constructs a feed off the specified search.

Returns an empty feed with a title and description only if search is null.

Parameters:

search -

feedProperties -

Returns:

a synd feed for the results of specified search

createFeed

com.sun.syndication.feed.synd.SyndFeed createFeed(ListQuery query,
                                                  FeedProperties feedProperties)

Constructs a feed after running a search based on the given query.

This method can be used instead of createFeed(ISearch, FeedProperties) when it is impossible to create a corresponding ISearch object from the given ListQuery. Eg. when search results need to be further filtered to satisfy a query. See CONF-7745 and CONF-9312.

Parameters:

query - the query to base the feed upon

feedProperties - metadata for the feed

Returns:

a synd feed for the results of the ListQuery