Package com.iizix.term.server

Class Descriptor

  • All Implemented Interfaces:
    IPluginDescriptor<ScreenProp>
    public class Descriptor
extends java.lang.Object
implements IPluginDescriptor<ScreenProp>
    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 
      ConstructorDescription
      Descriptor()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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<ScreenProp>getPropertyClass()
      Gets the property class for files.
      java.lang.Class<ScreenProp>[]getPropertyClasses()
      Gets the property class for files.
      java.lang.StringgetServerID()
      Gets the ID of the plug-in, e.g.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Descriptor

        public Descriptor()
        Constructor.

    • 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:
        getID in interface IPluginDescriptor<ScreenProp>
        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:
        getServerID in interface IPluginDescriptor<ScreenProp>
        Returns:
        Predefined descriptors such as Images, Panels, etc, return null.

      • getPropertiesURL

        public java.net.URL getPropertiesURL()
        Gets the properties file URL for "properties.xml".
        Specified by:
        getPropertiesURL in interface IPluginDescriptor<ScreenProp>
        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:
        getClassLoader in interface IPluginDescriptor<ScreenProp>
        Returns:
        A class loader or null to use the default class loader.

      • getModuleFileExtension

        public java.lang.String getModuleFileExtension()
        Gets the file extension used in Module projects, null for all.
        Specified by:
        getModuleFileExtension in interface IPluginDescriptor<ScreenProp>
        Returns:
        The file extension used in Module projects, null for all.

      • 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:
        getClasspathEntries in interface IPluginDescriptor<ScreenProp>
        Returns:
        A list of the classpath entries, or null for no special processing.