Package net.sf.basedb.core.plugin
Class AboutImpl
- java.lang.Object
-
- net.sf.basedb.core.plugin.AboutImpl
-
-
Field Summary
Fields Modifier and Type Field Description private String
contact
private String
copyright
private String
description
private String
email
private String
maxBaseVersion
private String
minBaseVersion
private String
name
private String
url
private String
version
-
Fields inherited from interface net.sf.basedb.core.plugin.About
MAX_INFORMATION_LENGTH
-
-
Constructor Summary
Constructors Constructor Description 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(String name, String description, String version, String minBaseVersion, String maxBaseVersion, String copyright, String contact, String email, String url)
Create a newAbout
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getContact()
Contact information to get more information about the plugin.String
getCopyright()
A copyright notice.String
getDescription()
A description of the plugin and what it does.String
getEmail()
An email adress to get more information about the plugin.String
getMaxBaseVersion()
Get the maximum BASE version were to plug-in no longer is expected to work.String
getMinBaseVersion()
Get the minimum BASE version that the plug-in requires.String
getName()
The name of the plugin.String
getUrl()
An URL to get more information about the plugin.String
getVersion()
The version of the plugin software.
-
-
-
Field Detail
-
name
private final String name
-
description
private final String description
-
version
private final String version
-
minBaseVersion
private final String minBaseVersion
-
maxBaseVersion
private final String maxBaseVersion
-
copyright
private final String copyright
-
contact
private final String contact
-
email
private final String email
-
url
private final String url
-
-
Constructor Detail
-
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 Detail
-
getContact
public String getContact()
Description copied from interface:About
Contact information to get more information about the plugin. May return null.- Specified by:
getContact
in interfaceAbout
-
getCopyright
public String getCopyright()
Description copied from interface:About
A copyright notice. May return null.- Specified by:
getCopyright
in interfaceAbout
-
getDescription
public String getDescription()
Description copied from interface:About
A description of the plugin and what it does. May return null.- Specified by:
getDescription
in interfaceAbout
-
getEmail
public String getEmail()
Description copied from interface:About
An email adress to get more information about the plugin. May return null.
-
getName
public String getName()
Description copied from interface:About
The name of the plugin. Mustn't return null.
-
getUrl
public String getUrl()
Description copied from interface:About
An URL to get more information about the plugin. May return null.
-
getVersion
public String getVersion()
Description copied from interface:About
The version of the plugin software. May return null.- Specified by:
getVersion
in interfaceAbout
-
getMinBaseVersion
public String 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
public String 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
-
-