Package org.apache.wiki.plugin
Class Counter
- java.lang.Object
-
- org.apache.wiki.plugin.Counter
-
- All Implemented Interfaces:
Plugin
public class Counter extends java.lang.Object implements Plugin
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 :
- name - Name of the counter. Optional.
- increment - The amount to increment, may be a negative value, default is 1. Optional.
- showResult - Should the counter value be visible on the page, default is true. Optional.
- Since:
- 1.9.30
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_NAMEstatic java.lang.StringPARAM_INCREMENTParameter name for setting the increment.static java.lang.StringPARAM_NAMEParameter name for setting the name.static java.lang.StringPARAM_SHOW_RESULTParameter name for setting the showResult.static java.lang.StringPARAM_STARTParameter name for setting the start.-
Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
-
Constructor Summary
Constructors Constructor Description Counter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Stringexecute(Context context, java.util.Map<java.lang.String,java.lang.String> params)
-
-
-
Field Detail
-
PARAM_NAME
public static final java.lang.String PARAM_NAME
Parameter name for setting the name. Value is "name".- See Also:
- Constant Field Values
-
PARAM_INCREMENT
public static final java.lang.String PARAM_INCREMENT
Parameter name for setting the increment. Value is "increment".- See Also:
- Constant Field Values
-
PARAM_SHOW_RESULT
public static final java.lang.String PARAM_SHOW_RESULT
Parameter name for setting the showResult. Value is "showResult".- See Also:
- Constant Field Values
-
PARAM_START
public static final java.lang.String PARAM_START
Parameter name for setting the start. Value is "start".- See Also:
- Constant Field Values
-
DEFAULT_NAME
public static final java.lang.String DEFAULT_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Counter
public Counter()
-
-
Method Detail
-
execute
public java.lang.String execute(Context context, java.util.Map<java.lang.String,java.lang.String> params) throws PluginException
- Specified by:
executein interfacePlugin- Throws:
PluginException
-
-