Package net.sf.basedb.util.extensions

Class AboutBean

java.lang.Object
net.sf.basedb.util.extensions.AboutBean
All Implemented Interfaces:
About, ExtendedAbout
public class AboutBean extends Object implements About, ExtendedAbout
An implementation of the About interface, which complements all getter methods with setter methods.
Version:
2.7
Author:
nicklas
Last modified
$Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $

  • Field Details

    • name

      private String name

    • description

      private String description

    • version

      private String version

    • minBaseVersion

      private String minBaseVersion

    • maxBaseVersion

      private String maxBaseVersion

    • contact

      private String contact

    • email

      private String email

    • url

      private String url

    • attributes

      private Map<String,String> attributes

  • Constructor Details

    • AboutBean

      public AboutBean()
      Create a new empty about instance.

  • 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

    • setContact

      public void setContact(String contact)

    • getCopyright

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

    • setCopyright

      public void setCopyright(String copyright)

    • 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

    • setDescription

      public void setDescription(String description)

    • 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

    • setEmail

      public void setEmail(String email)

    • getName

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

    • setName

      public void setName(String name)

    • 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

    • setUrl

      public void setUrl(String url)

    • getVersion

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

    • setVersion

      public void setVersion(String version)

    • 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

    • setMinBaseVersion

      public void setMinBaseVersion(String version)

    • 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

    • setMaxBaseVersion

      public void setMaxBaseVersion(String version)

    • 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

    • setAttribute

      public void setAttribute(String name, String value)
      Set an attribute for the given name.
      Since:
      3.3

    • copy

      public void copy(About from, boolean overwrite)
      Copy information from antoher About object to this one.
      Parameters:
      from - The object to copy from
      overwrite - TRUE copy all values, FALSE to only copy if the existing value is null