- All Known Implementing Classes:
Descriptor
,Descriptor
,Descriptor
public interface IPluginDescriptor<T extends PropCnr>
Plug-in descriptor used for the Server to load the plug-in's XML schema and get the appropriate class loader.
- Author:
- Christopher Mindus
Method Summary
Modifier and TypeMethodDescriptionclasspathEntriesFromClasses
(Class<?>... classes) Default implementation of getClasspathEntries() that can be used, but should be cached into a variable to avoid calculation.Gets the class loader to use for loading properties classes.Gets the URL's to the required classpath entries when running in the Server.Gets the description of the plug-in.getID()
Gets the ID of the plug-in, e.g.Gets the directory name in Module projects.Gets the file extension.Gets the properties file URL for "properties.xml".Gets the property class for files.Gets all the possible property class for files in case there is more than one.Gets the ID of the plug-in, e.g.
Method Details
getID
String getID()Gets the ID of the plug-in, e.g. "com.iizigo.db".- Returns:
- Predefined descriptors such as Images, Panels, etc, return null.
getServerID
String getServerID()Gets the ID of the plug-in, e.g. "com.iizix.db".- Returns:
- Predefined descriptors such as Images, Panels, etc, return null.
getDescription
String getDescription()Gets the description of the plug-in.- Returns:
- The description.
getPropertiesURL
URL getPropertiesURL()Gets the properties file URL for "properties.xml".- Returns:
- The URL for the properties file.
getClassLoader
ClassLoader getClassLoader()Gets the class loader to use for loading properties classes.- Returns:
- A class loader or null to use the default class loader.
getModuleDirectory
String getModuleDirectory()Gets the directory name in Module projects.- Returns:
- The module directory name.
getModuleFileExtension
String getModuleFileExtension()Gets the file extension.- Returns:
- The file extension used in Module projects, null for all.
getPropertyClass
Gets the property class for files.- Returns:
- The main property class used, null if there are multiple ones, in which case the
getPropertyClasses()
method must be used.
getPropertyClasses
Gets all the possible property class for files in case there is more than one.- Returns:
- The main property class used.
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.- Returns:
- A list of the classpath entries, or null for no special processing.
classpathEntriesFromClasses
Default implementation of getClasspathEntries() that can be used, but should be cached into a variable to avoid calculation.- Parameters:
classes
- A list of classes where to grab URL's and check the classpath. Use a class from every bundle or Jar to get all URL's.- Returns:
- A list of URL's without duplicates, in the ordering of the classes.