com.atlassian.confluence.rss
Class RssRenderItem

java.lang.Object
  extended by com.atlassian.confluence.rss.RssRenderItem

public class RssRenderItem
extends java.lang.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(ConfluenceEntityObject entity, FeedProperties feedProperties, com.atlassian.user.User modifier, com.atlassian.user.User user, DateFormatter dateFormatter)
           
 
Method Summary
 DateFormatter getDateFormatter()
           
 java.util.Map getDefaultVelocityContext()
          Provides a default Velocity context for rendering this item.
 ConfluenceEntityObject getEntity()
           
 com.atlassian.user.User getModifier()
           
 com.atlassian.user.User getUser()
           
 boolean isShowContent()
           
 boolean isShowDifferences()
           
 void setDateFormatter(DateFormatter dateFormatter)
           
 void setEntity(ConfluenceEntityObject entity)
           
 void setShowContent(boolean showContent)
           
 void setShowDifferences(boolean showDifferences)
           
 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(ConfluenceEntityObject entity,
                     FeedProperties feedProperties,
                     com.atlassian.user.User modifier,
                     com.atlassian.user.User user,
                     DateFormatter dateFormatter)
Method Detail

getEntity

public ConfluenceEntityObject getEntity()

isShowContent

public boolean isShowContent()

isShowDifferences

public boolean isShowDifferences()

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(ConfluenceEntityObject entity)

setShowContent

public void setShowContent(boolean showContent)

setShowDifferences

public void setShowDifferences(boolean showDifferences)

setUser

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

setDateFormatter

public void setDateFormatter(DateFormatter dateFormatter)

getDefaultVelocityContext

public java.util.Map 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


Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.