Package com.iizix.db.server
Class Descriptor
- java.lang.Object
- com.iizix.db.server.Descriptor
- All Implemented Interfaces:
IPluginDescriptor<DatabaseProps>
public class Descriptor extends java.lang.Object implements IPluginDescriptor<DatabaseProps>
Plug-in descriptor used for the Server to load the plug-in's XML schema and get the appropriate class loader.- Author:
- Christopher Mindus
Constructor Summary
Constructors Constructor Description Descriptor()Constructor.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.ClassLoadergetClassLoader()Gets the class loader to use for loading properties classes.java.util.List<java.net.URL>getClasspathEntries()Gets the URL's to the required classpath entries when running in the Server.java.lang.StringgetDescription()Gets the description of the plug-in.java.lang.StringgetID()Gets the ID of the plug-in, e.g.java.lang.StringgetModuleDirectory()Gets the directory name in Module projects.java.lang.StringgetModuleFileExtension()Gets the file extension used in Module projects, null for all.java.net.URLgetPropertiesURL()Gets the properties file URL for "properties.xml".java.lang.Class<DatabaseProps>getPropertyClass()Gets the property class for files.java.lang.Class<DatabaseProps>[]getPropertyClasses()Gets the property class for files.java.lang.StringgetServerID()Gets the ID of the plug-in, e.g.
Method Detail
getID
public java.lang.String getID()
Gets the ID of the plug-in, e.g. "com.iizigo.db". Predefined descriptors such as Images, Panels, etc, return null.- Specified by:
getIDin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- Predefined descriptors such as Images, Panels, etc, return null.
getServerID
public java.lang.String getServerID()
Gets the ID of the plug-in, e.g. "com.iizix.db". Predefined descriptors such as Images, Panels, etc, return null.- Specified by:
getServerIDin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- Predefined descriptors such as Images, Panels, etc, return null.
getDescription
public java.lang.String getDescription()
Gets the description of the plug-in.- Specified by:
getDescriptionin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The description.
getPropertiesURL
public java.net.URL getPropertiesURL()
Gets the properties file URL for "properties.xml".- Specified by:
getPropertiesURLin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The URL for the properties file.
getClassLoader
public java.lang.ClassLoader getClassLoader()
Gets the class loader to use for loading properties classes.- Specified by:
getClassLoaderin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- A class loader or null to use the default class loader.
getModuleDirectory
public java.lang.String getModuleDirectory()
Gets the directory name in Module projects.- Specified by:
getModuleDirectoryin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The module directory name.
getModuleFileExtension
public java.lang.String getModuleFileExtension()
Gets the file extension used in Module projects, null for all.- Specified by:
getModuleFileExtensionin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The file extension used in Module projects, null for all.
getPropertyClass
public java.lang.Class<DatabaseProps> getPropertyClass()
Gets the property class for files.- Specified by:
getPropertyClassin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The main property class used, null if there are multiple ones, in which case the
IPluginDescriptor.getPropertyClasses()method must be used.
getPropertyClasses
public java.lang.Class<DatabaseProps>[] getPropertyClasses()
Gets the property class for files.- Specified by:
getPropertyClassesin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- The main property class used.
getClasspathEntries
public java.util.List<java.net.URL> getClasspathEntries()
Gets the URL's to the required classpath entries when running in the Server. This method is also called from the Designer, and the reply should include a representation of the same libraries or paths.- Specified by:
getClasspathEntriesin interfaceIPluginDescriptor<DatabaseProps>- Returns:
- A list of the classpath entries, or null for no special processing.