Summary: Methods | [Expand All]
public interface

FeedBuilder

com.atlassian.confluence.rss.FeedBuilder
Known Indirect Subclasses

Class Overview

Builds a feed.

Summary

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

Public Methods

public abstract 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

public abstract SyndFeed createFeed (ListQuery query, boolean showContent, boolean showDiff, User user)

This method is 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

public abstract 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.

Returns
  • a synd feed for the results of specified search

public abstract SyndFeed createPublicFeed (ListQuery query, boolean showContent, boolean showDiff)

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