Package net.sf.basedb.util.extensions

Class Registry.RegisteredAbout

java.lang.Object

net.sf.basedb.util.extensions.Registry.RegisteredAbout

All Implemented Interfaces:

About, ExtendedAbout

Enclosing class:

Registry

static class Registry.RegisteredAbout
extends Object
implements About, ExtendedAbout

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,String>	attributes
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
RegisteredAbout(About about)	Create a new registered about by copying the information from the parameter.

Method Summary

Modifier and Type	Method	Description
String	getAttribute(String name)	Get extra information
Collection<String>	getAttributeNames()	Get all extra attribute names.
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.
(package private) void	update(About about)	Update the registered information.

Methods inherited from class java.lang.Object

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

Field Details

name

private String name

description

private String description

version

private String version

minBaseVersion

private String minBaseVersion

maxBaseVersion

private String maxBaseVersion

copyright

private String copyright

contact

private String contact

email

private String email

url

private String url

attributes

private Map<String,String> attributes

Constructor Details

RegisteredAbout

RegisteredAbout(About about)

Create a new registered about by copying the information from the parameter.

Method Details

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

getAttribute

public String getAttribute(String name)

Description copied from interface: ExtendedAbout

Get extra information

Specified by:

getAttribute in interface ExtendedAbout

Parameters:

name - The name of the extra information

Returns:

A value or null if no information is present

getAttributeNames

public Collection<String> getAttributeNames()

Description copied from interface: ExtendedAbout

Get all extra attribute names.

Specified by:

getAttributeNames in interface ExtendedAbout

Returns:

A collection which may be null or empty

update

void update(About about)

Update the registered information.