com.xpn.xwiki.render.macro.rss
Class RSSMacroParameters

java.lang.Object
  extended by com.xpn.xwiki.render.macro.rss.RSSMacroParameters

public class RSSMacroParameters
extends Object

A simple bean which encapsulates macro parameters and does some logic, like making sure the feed property, a String is a well-formed URL, and evaluating the count property against a proposed number of items, in light of the possibility that count may not have been defined.

Version:
0.2d
Author:
Joe Germuska

Field Summary
static String DEFAULT_ALIGNMENT
           
static int UNDEFINED
           
 
Constructor Summary
RSSMacroParameters()
           
 
Method Summary
 int evalCount(int proposed)
          Given proposed items and the current value of our count property, how many items should be processed? If count is undefined or greater than proposed, return proposed, otherwise return count.
 String getAlign()
           
 int getCount()
           
 String getFeed()
           
 URL getFeedURL()
           
 boolean isCss()
           
 boolean isFull()
           
 boolean isImg()
           
 boolean isSearch()
           
 void setAlign(String align)
           
 void setCount(int count)
           
 void setCss(boolean css)
           
 void setFeed(String feed)
           
 void setFull(boolean full)
           
 void setImg(boolean img)
           
 void setSearch(boolean search)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_ALIGNMENT

public static final String DEFAULT_ALIGNMENT
See Also:
Constant Field Values

UNDEFINED

public static final int UNDEFINED
See Also:
Constant Field Values
Constructor Detail

RSSMacroParameters

public RSSMacroParameters()
Method Detail

getFeed

public String getFeed()

setFeed

public void setFeed(String feed)
             throws MalformedURLException
Throws:
MalformedURLException

setAlign

public void setAlign(String align)

getAlign

public String getAlign()

setImg

public void setImg(boolean img)

isImg

public boolean isImg()

setCss

public void setCss(boolean css)

isCss

public boolean isCss()

setCount

public void setCount(int count)

getCount

public int getCount()

getFeedURL

public URL getFeedURL()

evalCount

public int evalCount(int proposed)
Given proposed items and the current value of our count property, how many items should be processed? If count is undefined or greater than proposed, return proposed, otherwise return count.

Parameters:
proposed -
Returns:

setFull

public void setFull(boolean full)

isFull

public boolean isFull()

setSearch

public void setSearch(boolean search)

isSearch

public boolean isSearch()


Copyright © 2004-2013 XWiki. All Rights Reserved.