Package org.robwork.sdurw_core

Class Extension.Descriptor

  • Enclosing class:
    Extension
    public static class Extension.Descriptor
extends java.lang.Object
    An extension descriptor.

    The descriptor holds meta-data for an extension, and makes it possible to do lazy-loading
    of plugins.

    • Constructor Summary

      Constructors 
      Constructor Description
      Descriptor()
      Construct empty descriptor.
      Descriptor​(long cPtr, boolean cMemoryOwn)  
      Descriptor​(java.lang.String id_, java.lang.String point_)
      Construct new descriptor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()  
      static long getCPtr​(Extension.Descriptor obj)  
      java.lang.String getId()
      A unique id of an extension.
      java.lang.String getName()
      A human-readable name of an extension.
      java.lang.String getPoint()
      The extension point that this extension extends.
      PropertyMap getProperties()
      Get the extension properties.

      The properties will typically include information about the file extensions supported
      by the plugin, or other meta-data required to determine the proper extension to use.
      PropertyMap getProps()
      Properties of the extension.
      void setId​(java.lang.String value)
      A unique id of an extension.
      void setName​(java.lang.String value)
      A human-readable name of an extension.
      void setPoint​(java.lang.String value)
      The extension point that this extension extends.
      void setProps​(PropertyMap value)
      Properties of the extension.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Descriptor

        public Descriptor​(long cPtr,
                  boolean cMemoryOwn)

      • Descriptor

        public Descriptor()
        Construct empty descriptor.

      • Descriptor

        public Descriptor​(java.lang.String id_,
                  java.lang.String point_)
        Construct new descriptor.
        Parameters:
        id_ - [in] a unique id of the extension.
        point_ - [in] the extension point.

    • Method Detail

      • delete

        public void delete()

      • setId

        public void setId​(java.lang.String value)
        A unique id of an extension.

      • getId

        public java.lang.String getId()
        A unique id of an extension.

      • setName

        public void setName​(java.lang.String value)
        A human-readable name of an extension.

      • getName

        public java.lang.String getName()
        A human-readable name of an extension.

      • setPoint

        public void setPoint​(java.lang.String value)
        The extension point that this extension extends.

      • getPoint

        public java.lang.String getPoint()
        The extension point that this extension extends.

      • setProps

        public void setProps​(PropertyMap value)
        Properties of the extension.

      • getProps

        public PropertyMap getProps()
        Properties of the extension.

      • getProperties

        public PropertyMap getProperties()
        Get the extension properties.

        The properties will typically include information about the file extensions supported
        by the plugin, or other meta-data required to determine the proper extension to use.

        Returns:
        a reference to the properties.