Package net.sf.basedb.core.plugin
Class AboutImpl
java.lang.Object
net.sf.basedb.core.plugin.AboutImpl
- All Implemented Interfaces:
About
A simple implementation of the
About
interface.- Version:
- 2.0
- Author:
- Enell
- Last modified
- $Date$
-
Field Summary
Modifier and TypeFieldDescriptionprivate final String
private final String
private final String
private final String
private final String
private final String
private final String
private final String
private final String
Fields inherited from interface net.sf.basedb.core.plugin.About
MAX_INFORMATION_LENGTH
-
Constructor Summary
ConstructorDescriptionAboutImpl
(String name, String description, String version, String copyright, String contact, String email, String url) Create a new about object without any min or max BASE version requirement.AboutImpl
(String name, String description, String version, String minBaseVersion, String maxBaseVersion, String copyright, String contact, String email, String url) Create a newAbout
object. -
Method Summary
Modifier and TypeMethodDescriptionContact information to get more information about the plugin.A copyright notice.A description of the plugin and what it does.getEmail()
An email adress to get more information about the plugin.Get the maximum BASE version were to plug-in no longer is expected to work.Get the minimum BASE version that the plug-in requires.getName()
The name of the plugin.getUrl()
An URL to get more information about the plugin.The version of the plugin software.
-
Field Details
-
name
-
description
-
version
-
minBaseVersion
-
maxBaseVersion
-
copyright
-
contact
-
email
-
url
-
-
Constructor Details
-
AboutImpl
public AboutImpl(String name, String description, String version, String copyright, String contact, String email, String url) Create a new about object without any min or max BASE version requirement. -
AboutImpl
public AboutImpl(String name, String description, String version, String minBaseVersion, String maxBaseVersion, String copyright, String contact, String email, String url) Create a newAbout
object.- Parameters:
name
- The name of the plugin, null not alloweddescription
- A description of the pluginversion
- The version of the pluginminBaseVersion
- The minium version of BASE that is required by the pluginmaxBaseVersion
- The maxium version of BASE that the plugin is expected to work withcopyright
- A copyright noticecontact
- Contact information for the pluginemail
- An email adress to get more information about the pluginurl
- An URL to get more inforamtion about the plugin- Throws:
NullPointerException
- If the name is null- Since:
- 3.0
-
-
Method Details
-
getContact
Description copied from interface:About
Contact information to get more information about the plugin. May return null.- Specified by:
getContact
in interfaceAbout
-
getCopyright
Description copied from interface:About
A copyright notice. May return null.- Specified by:
getCopyright
in interfaceAbout
-
getDescription
Description copied from interface:About
A description of the plugin and what it does. May return null.- Specified by:
getDescription
in interfaceAbout
-
getEmail
Description copied from interface:About
An email adress to get more information about the plugin. May return null. -
getName
Description copied from interface:About
The name of the plugin. Mustn't return null. -
getUrl
Description copied from interface:About
An URL to get more information about the plugin. May return null. -
getVersion
Description copied from interface:About
The version of the plugin software. May return null.- Specified by:
getVersion
in interfaceAbout
-
getMinBaseVersion
Description copied from interface:About
Get the minimum BASE version that the plug-in requires. The returned value should be 2 or 3 numbers separated by a dot (eg. 3.0, 3.1.2, etc). A null return value indicates that the plug-in works with all BASE versions.- Specified by:
getMinBaseVersion
in interfaceAbout
- Returns:
- A string or null
-
getMaxBaseVersion
Description copied from interface:About
Get the maximum BASE version were to plug-in no longer is expected to work. The returned value should be 2 or 3 numbers separated by a dot (eg. 3.0, 3.1.2, etc). A null return value indicates that the plug-in works with all BASE versions.- Specified by:
getMaxBaseVersion
in interfaceAbout
- Returns:
- A string or null
-