AbstractPlugin (Latke Core 3.0.6 API)

java.lang.Object
- org.b3log.latke.plugin.AbstractPlugin

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NotInteractivePlugin
```
public abstract class AbstractPlugin
extends Object
implements Serializable
```
Abstract plugin.
Id of a plugin is name_version. See PluginManager.setPluginProps(String, AbstractPlugin, Properties) for more details. If the id of one plugin equals to another's, considering they are the same.

Note: The subclass extends from this abstract class MUST has a static method named getInstance to obtain an instance of this plugin. See Singleton Pattern for more implementation details.

Version:

1.3.2.2, Dec 5, 2018

Author:

Liang Ding, Love Yao

See Also:

PluginManager, PluginStatus, PluginType, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbstractPlugin()

Constructors
Constructor and Description
`AbstractPlugin()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventListener(AbstractEventListener<?> eventListener)` Adds the specified event listener.
`void`	`addType(PluginType type)` Adds the specified type.
`void`	`changeStatus()` when the plugin change the status,it should note the pointcut lifecycle to know.
`boolean`	`equals(Object obj)`
`String`	`getAuthor()` Gets the author of this plugin.
`String`	`getDirName()` Gets the directory name of this plugin.
`String`	`getId()` Gets the id.
`String`	`getLang(Locale locale, String key)` Gets language label with the specified locale and key.
`String`	`getName()` Gets the name of this plugin.
`String`	`getRendererId()` getRendererId.
`JSONObject`	`getSetting()` getSetting.
`PluginStatus`	`getStatus()` Gets the status of this plugin.
`Set<PluginType>`	`getTypes()` Gets the types of this plugin.
`String`	`getVersion()` Gets the version of this plugin.
`int`	`hashCode()`
`void`	`plug(Map<String,Object> dataModel)` Plugs with the specified data model.
`void`	`plug(Map<String,Object> dataModel, RequestContext context)` Plugs with the specified data model and the args from request.
`abstract void`	`postPlug(Map<String,Object> dataModel, RequestContext context)` postPlug after the dataModel of the simplest-view be generated.
`abstract void`	`prePlug(RequestContext context)` prePlug after the real method be invoked.
`void`	`readLangs()` Reads lang_xx.properties into field `langs`.
`void`	`setAuthor(String author)` Sets the author of this plugin with the specified author.
`void`	`setDir(String dirName)` Sets the directory name of this plugin with the specified directory.
`void`	`setId(String id)` Sets the id with the specified id.
`void`	`setName(String name)` Sets the name of this plugin with the specified name.
`void`	`setRendererId(String rendererId)` setRendererId.
`void`	`setSetting(JSONObject setting)` setSetting.
`void`	`setStatus(PluginStatus status)` Sets the status with the specified status.
`void`	`setVersion(String version)` Sets the version of this plugin with the specified version.
`protected void`	`start()` The lifecycle pointcut for the plugin to start(enable status).
`protected void`	`stop()` The lifecycle pointcut for the plugin to close(disable status).
`JSONObject`	`toJSONObject()` Converts this plugin to a json object (plugin description).
`void`	`unplug()` Unplugs.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractPlugin
```
public AbstractPlugin()
```
- Method Detail
  - addEventListener
```
public void addEventListener(AbstractEventListener<?> eventListener)
```
    Adds the specified event listener.
    
    Parameters:
    
    eventListener - the specified event listener
  - unplug
```
public void unplug()
```
    Unplugs.
  - getDirName
```
public String getDirName()
```
    Gets the directory name of this plugin.
    
    Returns:
    
    directory of this plugin
  - setDir
```
public void setDir(String dirName)
```
    Sets the directory name of this plugin with the specified directory. Initializes template engine configuration.
    
    Parameters:
    
    dirName - the specified directory name
  - readLangs
```
public void readLangs()
```
    Reads lang_xx.properties into field langs.
  - getLang
```
public String getLang(Locale locale,
                      String key)
```
    Gets language label with the specified locale and key.
    
    Parameters:
    
    locale - the specified locale
    
    key - the specified key
    
    Returns:
    
    language label
  - prePlug
```
public abstract void prePlug(RequestContext context)
```
    prePlug after the real method be invoked.
    
    Parameters:
    
    context - context
  - postPlug
```
public abstract void postPlug(Map<String,Object> dataModel,
                              RequestContext context)
```
    postPlug after the dataModel of the simplest-view be generated.
    
    Parameters:
    
    dataModel - dataModel
    
    context - context
  - start
```
protected void start()
```
    The lifecycle pointcut for the plugin to start(enable status).
  - stop
```
protected void stop()
```
    The lifecycle pointcut for the plugin to close(disable status).
  - plug
```
public void plug(Map<String,Object> dataModel)
```
    Plugs with the specified data model.
    
    Parameters:
    
    dataModel - the specified data model
  - plug
```
public void plug(Map<String,Object> dataModel,
                 RequestContext context)
```
    Plugs with the specified data model and the args from request.
    
    Parameters:
    
    dataModel - dataModel
    
    context - context
  - toJSONObject
```
public JSONObject toJSONObject()
                        throws JSONException
```
    Converts this plugin to a json object (plugin description).
    Returns:
    a json object, for example,
    { "oId": "", "name": "", "version": "", "author": "", "status": "" // Enumeration name of PluginStatus }
    Throws:
    
    JSONException - if can not convert
  - getId
```
public String getId()
```
    Gets the id.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
    Sets the id with the specified id.
    
    Parameters:
    
    id - the specified id
  - setStatus
```
public void setStatus(PluginStatus status)
```
    Sets the status with the specified status.
    
    Parameters:
    
    status - the specified status
  - getStatus
```
public PluginStatus getStatus()
```
    Gets the status of this plugin.
    
    Returns:
    
    status
  - getAuthor
```
public String getAuthor()
```
    Gets the author of this plugin.
    
    Returns:
    
    author
  - setAuthor
```
public void setAuthor(String author)
```
    Sets the author of this plugin with the specified author.
    
    Parameters:
    
    author - the specified author
  - getName
```
public String getName()
```
    Gets the name of this plugin.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    Sets the name of this plugin with the specified name.
    
    Parameters:
    
    name - the specified name
  - getVersion
```
public String getVersion()
```
    Gets the version of this plugin.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(String version)
```
    Sets the version of this plugin with the specified version.
    
    Parameters:
    
    version - the specified version
  - getSetting
```
public JSONObject getSetting()
```
    getSetting.
    
    Returns:
    
    the setting
  - setSetting
```
public void setSetting(JSONObject setting)
```
    setSetting.
    
    Parameters:
    
    setting - the setting to set
  - getTypes
```
public Set<PluginType> getTypes()
```
    Gets the types of this plugin.
    
    Returns:
    
    types
  - getRendererId
```
public String getRendererId()
```
    getRendererId.
    
    Returns:
    
    the rendererId
  - setRendererId
```
public void setRendererId(String rendererId)
```
    setRendererId.
    
    Parameters:
    
    rendererId - the rendererId to set
  - addType
```
public void addType(PluginType type)
```
    Adds the specified type.
    
    Parameters:
    
    type - the specified type
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - changeStatus
```
public void changeStatus()
```
    when the plugin change the status,it should note the pointcut lifecycle to know.
    to enable :start() to disable :stop()

Class AbstractPlugin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPlugin

Method Detail

addEventListener

unplug

getDirName

setDir

readLangs

getLang

prePlug

postPlug

start

stop

plug

plug

toJSONObject

getId

setId

setStatus

getStatus

getAuthor

setAuthor

getName

setName

getVersion

setVersion

getSetting

setSetting

getTypes

getRendererId

setRendererId

addType

equals

hashCode

changeStatus