com.atlassian.confluence.rss
Class RssRenderItem<T>

java.lang.Object
  com.atlassian.confluence.rss.RssRenderItem<T>

public class RssRenderItem<T>
extends Object

Contains the configuration necessary for an implementation of RssRenderSupport to render an RSS item. Typically constructed by the FeedBuilder.

This bean includes fields that some implementations may not care about. For example, showContent and showDifferences won't be relevant for attachments.

Constructor Summary

RssRenderItem(T entity, FeedProperties feedProperties, com.atlassian.user.User modifier, com.atlassian.user.User user, DateFormatter dateFormatter)

Method Summary

DateFormatter	getDateFormatter()
Map<String,Object>	getDefaultVelocityContext() Provides a default Velocity context for rendering this item.
T	getEntity()
com.atlassian.user.User	getModifier()
com.atlassian.user.User	getUser()
boolean	isShowContent()
boolean	isShowDifferences() Deprecated. Since 4.0. We no longer support diffs in RSS feeds.
void	setDateFormatter(DateFormatter dateFormatter)
void	setEntity(T entity)
void	setShowContent(boolean showContent)
void	setShowDifferences(boolean showDifferences) Deprecated. Since 4.0. We no longer support diffs in RSS items so any setting here is ignored.
void	setUser(com.atlassian.user.User user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RssRenderItem

public RssRenderItem(T entity,
                     FeedProperties feedProperties,
                     com.atlassian.user.User modifier,
                     com.atlassian.user.User user,
                     DateFormatter dateFormatter)

Method Detail

getEntity

public T getEntity()

isShowContent

public boolean isShowContent()

isShowDifferences

@Deprecated
public boolean isShowDifferences()

Deprecated. Since 4.0. We no longer support diffs in RSS feeds.

Returns:

getUser

public com.atlassian.user.User getUser()

Returns:

the user who authorised the feed if a private feed, or null for a public feed.

getModifier

public com.atlassian.user.User getModifier()

getDateFormatter

public DateFormatter getDateFormatter()

setEntity

public void setEntity(T entity)

setShowContent

public void setShowContent(boolean showContent)

setShowDifferences

@Deprecated
public void setShowDifferences(boolean showDifferences)

Deprecated. Since 4.0. We no longer support diffs in RSS items so any setting here is ignored.

Parameters:

showDifferences -

setUser

public void setUser(com.atlassian.user.User user)

setDateFormatter

public void setDateFormatter(DateFormatter dateFormatter)

getDefaultVelocityContext

public Map<String,Object> getDefaultVelocityContext()

Provides a default Velocity context for rendering this item. It pulls the default context from MacroUtils.defaultVelocityContext() and adds the user and dateFormatter parameters.

Returns:

a velocity context for this item