3.2.1: 2012-12-13

net.sf.basedb.core.plugin
Class AboutImpl

java.lang.Object
  extended by net.sf.basedb.core.plugin.AboutImpl
All Implemented Interfaces:
About

public class AboutImpl
extends Object
implements About

A simple implementation of the About interface.

Version:
2.0
Author:
Enell
Last modified
$Date$

Field Summary
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
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 new About object.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 new About object.

Parameters:
name - The name of the plugin, null not allowed
description - A description of the plugin
version - The version of the plugin
minBaseVersion - The minium version of BASE that is required by the plugin
maxBaseVersion - The maxium version of BASE that the plugin is expected to work with
copyright - A copyright notice
contact - Contact information for the plugin
email - An email adress to get more information about the plugin
url - 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 interface About

getCopyright

public String getCopyright()
Description copied from interface: About
A copyright notice. May return null.

Specified by:
getCopyright in interface About

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 interface About

getEmail

public String getEmail()
Description copied from interface: About
An email adress to get more information about the plugin. May return null.

Specified by:
getEmail in interface About

getName

public String getName()
Description copied from interface: About
The name of the plugin. Mustn't return null.

Specified by:
getName in interface About

getUrl

public String getUrl()
Description copied from interface: About
An URL to get more information about the plugin. May return null.

Specified by:
getUrl in interface About

getVersion

public String getVersion()
Description copied from interface: About
The version of the plugin software. May return null.

Specified by:
getVersion in interface About

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 interface About
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 interface About
Returns:
A string or null

3.2.1: 2012-12-13