Package org.apache.wiki.plugin
Class Counter
java.lang.Object
org.apache.wiki.plugin.Counter
- All Implemented Interfaces:
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".
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
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
Parameter name for setting the increment.static final String
Parameter name for setting the name.static final String
Parameter name for setting the showResult.static final String
Parameter name for setting the start.Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
PARAM_NAME
Parameter name for setting the name. Value is "name".- See Also:
-
PARAM_INCREMENT
Parameter name for setting the increment. Value is "increment".- See Also:
-
PARAM_SHOW_RESULT
Parameter name for setting the showResult. Value is "showResult".- See Also:
-
PARAM_START
Parameter name for setting the start. Value is "start".- See Also:
-
DEFAULT_NAME
- See Also:
-
-
Constructor Details
-
Counter
public Counter()
-
-
Method Details
-
execute
- Specified by:
execute
in interfacePlugin
- Throws:
PluginException
-