Package org.apache.wiki.plugin

Class WeblogEntryPlugin

java.lang.Object

org.apache.wiki.plugin.WeblogEntryPlugin

All Implemented Interfaces:

org.apache.wiki.api.plugin.Plugin

public class WeblogEntryPlugin
extends Object
implements org.apache.wiki.api.plugin.Plugin

Builds a simple weblog.

Parameters :

• entrytext - text of the link
• page - if set, the entry is added to the named blog page. The default is the current page.

Since:

1.9.21

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_BLOGNAME	Parameter name for setting the page Value is "page".
static final String	PARAM_ENTRYTEXT	Parameter name for setting the entrytext Value is "entrytext".

Fields inherited from interface org.apache.wiki.api.plugin.Plugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor	Description
WeblogEntryPlugin()

Method Summary

Modifier and Type	Method	Description
String	execute(org.apache.wiki.api.core.Context context, Map<String,String> params)
String	getDisplayName(Locale locale)
String	getNewEntryPage(org.apache.wiki.api.core.Engine engine, String blogName)	Returns a new page name for entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wiki.api.plugin.Plugin

getSnipExample

Field Details

PARAM_ENTRYTEXT

public static final String PARAM_ENTRYTEXT

Parameter name for setting the entrytext Value is "entrytext".

See Also:

• Constant Field Values

PARAM_BLOGNAME

public static final String PARAM_BLOGNAME

Parameter name for setting the page Value is "page".

See Also:

• Constant Field Values

Constructor Details

WeblogEntryPlugin

public WeblogEntryPlugin()

Method Details

getDisplayName

public String getDisplayName(Locale locale)

Specified by:

getDisplayName in interface org.apache.wiki.api.plugin.Plugin

getNewEntryPage

public String getNewEntryPage(org.apache.wiki.api.core.Engine engine,
 String blogName)
                       throws org.apache.wiki.api.exceptions.ProviderException

Returns a new page name for entries. It goes through the list of all blog pages, and finds out the next in line.

Parameters:

engine - A Engine

blogName - The page (or blog) name.

Returns:

A new name.

Throws:

org.apache.wiki.api.exceptions.ProviderException - If something goes wrong.

execute

public String execute(org.apache.wiki.api.core.Context context,
 Map<String,String> params)
               throws org.apache.wiki.api.exceptions.PluginException

Specified by:

execute in interface org.apache.wiki.api.plugin.Plugin

Throws:

org.apache.wiki.api.exceptions.PluginException