com.ecyrd.jspwiki.plugin
Class Counter

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.Counter
All Implemented Interfaces:
WikiPlugin

public class Counter
extends Object
implements WikiPlugin

Provides a page-specific counter, it is reset every time a page is rendered, so it is not usable as a hitcounter.
Stores a variable in the WikiContext called "counter", with the name of the optionally specified variable "name".
For example: If name is "thispage", then the variable name is called "counter-thispage".

Parameters :

Since:
1.9.30

Field Summary
static String DEFAULT_NAME
           
static String PARAM_INCREMENT
          Parameter name for setting the increment.
static String PARAM_NAME
          Parameter name for setting the name.
static String PARAM_SHOW_RESULT
          Parameter name for setting the showResult.
static String PARAM_START
          Parameter name for setting the start.
 
Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin
CORE_PLUGINS_RESOURCEBUNDLE
 
Constructor Summary
Counter()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_NAME

public static final String PARAM_NAME
Parameter name for setting the name. Value is "name".

See Also:
Constant Field Values

PARAM_INCREMENT

public static final String PARAM_INCREMENT
Parameter name for setting the increment. Value is "increment".

See Also:
Constant Field Values

PARAM_SHOW_RESULT

public static final String PARAM_SHOW_RESULT
Parameter name for setting the showResult. Value is "showResult".

See Also:
Constant Field Values

PARAM_START

public static final String PARAM_START
Parameter name for setting the start. Value is "start".

See Also:
Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME
See Also:
Constant Field Values
Constructor Detail

Counter

public Counter()
Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.

Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.

Specified by:
execute in interface WikiPlugin
Parameters:
context - The current WikiContext.
params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.
Returns:
HTML, ready to be included into the rendered page.
Throws:
PluginException - In case anything goes wrong.