3.0.1: 2011-11-10

net.sf.basedb.util.extensions.xml
Class PluginInfo

java.lang.Object
  extended by net.sf.basedb.util.extensions.xml.PluginInfo

public class PluginInfo
extends Object

Object for holding information about a plug-in definition as it is loaded from the extensions definition file. This class has no effect on the actual installed plug-ins. To get more information about what is installed and what is not, call PluginDefinition.checkInstallation(DbControl, java.util.Collection).

Since:
3.0
Author:
Nicklas
Last modified
$Date: 2011-10-24 12:47:31 +0200 (Mon, 24 Oct 2011) $

Field Summary
private  About about
           
private  String className
           
private  boolean disabled
           
private  String id
           
private  int internalId
           
static Comparator<PluginInfo> NAME_COMPARATOR
          Comparator that sort plug-ins according to their names.
private  boolean notFound
           
private  Map<String,String> properties
           
private  Plugin.MainType type
           
 
Constructor Summary
PluginInfo(String id)
          Create a new information object.
 
Method Summary
 About getAbout()
          Get information about the authors of the plug-in.
 String getClassName()
          Get the class name of the plug-in.
 int getInternalId()
          Get the internal if of this plug-in.
 String getProperty(String name)
           
 Plugin.MainType getType()
          Get the main type of the plug-in.
 boolean isDisabled()
          Is this plug-in enabled or not?
 boolean isInstalled()
          Is this plug-in installed or not?
 boolean isNotFound()
          Does this plug-in exists on the server or not?
 void setAbout(About about)
           
 void setClassName(String className)
           
 void setDisabled(boolean disabled)
           
 void setInternalId(int internalId)
           
 void setNotFound(boolean notFound)
           
 void setProperty(String name, String value)
           
 void setType(Plugin.MainType type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME_COMPARATOR

public static final Comparator<PluginInfo> NAME_COMPARATOR
Comparator that sort plug-ins according to their names. If two names are equal, the sort is also done on the class name.


id

private final String id

about

private About about

type

private Plugin.MainType type

className

private String className

properties

private Map<String,String> properties

internalId

private int internalId

disabled

private boolean disabled

notFound

private boolean notFound
Constructor Detail

PluginInfo

public PluginInfo(String id)
Create a new information object.

Method Detail

getClassName

public String getClassName()
Get the class name of the plug-in.


setClassName

public void setClassName(String className)

getAbout

public About getAbout()
Get information about the authors of the plug-in.


setAbout

public void setAbout(About about)

getType

public Plugin.MainType getType()
Get the main type of the plug-in. This information may not be available for plug-ins that has not been installed.


setType

public void setType(Plugin.MainType type)

setProperty

public void setProperty(String name,
                        String value)

getProperty

public String getProperty(String name)

getInternalId

public int getInternalId()
Get the internal if of this plug-in. This information is only available after PluginDefinition.checkInstallation(DbControl, java.util.Collection) has been called.


setInternalId

public void setInternalId(int internalId)

isInstalled

public boolean isInstalled()
Is this plug-in installed or not?


isDisabled

public boolean isDisabled()
Is this plug-in enabled or not?


setDisabled

public void setDisabled(boolean disabled)

isNotFound

public boolean isNotFound()
Does this plug-in exists on the server or not?


setNotFound

public void setNotFound(boolean notFound)

3.0.1: 2011-11-10