Package com.pnfsoftware.jeb.core

Class PluginInformation

java.lang.Object

com.pnfsoftware.jeb.core.PluginInformation

All Implemented Interfaces:

IPluginInformation

Direct Known Subclasses:

EditablePluginInformation

public class PluginInformation
extends Object
implements IPluginInformation

Standard implementation of a plugin information object.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	author
protected String	description
protected Version	maxCoreVersion
protected Version	minCoreVersion
protected String	name
protected Version	version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluginInformation()
	PluginInformation(String name, String description, String author, Version version)	Create a new plugin information object, without specifying JEB core version requirements.
	PluginInformation(String name, String description, String author, Version version, Version minCoreVersion)	Create a new plugin information objects.
	PluginInformation(String name, String description, String author, Version version, Version minCoreVersion, Version maxCoreVersion)	Create a new plugin information objects.

Method Summary

Modifier and Type	Method	Description
String	getAuthor()	Get the plugin author.
String	getDescription()	Get the plugin description.
Version	getMaximumCoreVersion()	Get the maximum supported core version.
Version	getMinimumCoreVersion()	Get the minimum required core version.
String	getName()	Get the plugin name.
Version	getVersion()	Get the plugin version.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

description

protected String description

author

protected String author

version

protected Version version

minCoreVersion

protected Version minCoreVersion

maxCoreVersion

protected Version maxCoreVersion

Constructor Details

PluginInformation

public PluginInformation(String name,
 String description,
 String author,
 Version version,
 Version minCoreVersion,
 Version maxCoreVersion)

Create a new plugin information objects. All fields are optional.

Parameters:

name - plugin name

description - plugin description

author - plugin author (individual or company)

version - plugin version

minCoreVersion - optional minimal version of the back-end requested to run the plugin

maxCoreVersion - optional maximum version of the back-end requested to run the plugin

PluginInformation

public PluginInformation(String name,
 String description,
 String author,
 Version version,
 Version minCoreVersion)

Create a new plugin information objects.

Parameters:

name - plugin name

description - plugin description

author - plugin author (individual or company)

version - plugin version

minCoreVersion - optional minimal version of the back-end requested to run the plugin

PluginInformation

public PluginInformation(String name,
 String description,
 String author,
 Version version)

Create a new plugin information object, without specifying JEB core version requirements. All fields are optional.

Parameters:

name - plugin name

description - plugin description

author - plugin author

version - plugin version

PluginInformation

protected PluginInformation()

Method Details

getName

public String getName()

Get the plugin name.

Specified by:

getName in interface IPluginInformation

Returns:

plugin name, or null if unnamed

getDescription

public String getDescription()

Get the plugin description.

Specified by:

getDescription in interface IPluginInformation

Returns:

plugin description, or null if absent

getAuthor

public String getAuthor()

Get the plugin author.

Specified by:

getAuthor in interface IPluginInformation

Returns:

plugin author, or null if absent

getVersion

public Version getVersion()

Get the plugin version.

Specified by:

getVersion in interface IPluginInformation

Returns:

plugin version, or null if absent

getMinimumCoreVersion

public Version getMinimumCoreVersion()

Get the minimum required core version.

Specified by:

getMinimumCoreVersion in interface IPluginInformation

Returns:

minimum core version, or null if unspecified

getMaximumCoreVersion

public Version getMaximumCoreVersion()

Get the maximum supported core version.

Specified by:

getMaximumCoreVersion in interface IPluginInformation

Returns:

maximum core version, or null if unspecified

toString

public String toString()

Overrides:

toString in class Object