Interface Annot8ComponentDescriptor<T extends Annot8Component,​S extends Settings>

  • Type Parameters:
    T - The Annot8 component described by this descriptor
    S - The settings used by this component, or NoSettings if the component doesn't use settings
    All Known Subinterfaces:
    ProcessorDescriptor<T,​S>, SourceDescriptor<T,​S>

    public interface Annot8ComponentDescriptor<T extends Annot8Component,​S extends Settings>
    Descriptor for an Annot8 component

    Descriptors provide contextual information about a component, for example a name and it's configuration, as well as a method to create an instance of that component.

    Descriptors should be serializable, as they can be used to recreate pipelines.

    • Method Detail

      • setName

        void setName​(String name)
        Set the name of this component
        Parameters:
        name - name of the component
      • getName

        String getName()
        Get the name of this component
        Returns:
        name of the component
      • setSettings

        void setSettings​(S settings)
        Set the settings for this component
        Parameters:
        settings - the settings to apply
      • getSettings

        S getSettings()
        Get the settings for this component
        Returns:
        settings used to create the component (or null)
      • capabilities

        Capabilities capabilities()
        Get the capabilities of the component, as configured with the current settings
        Returns:
        the capabilities of the component (wrt to the settings)
      • create

        T create​(Context context)
        Create an instance of the component, with the current settings and using the provided context
        Parameters:
        context - the context used to create the new instance
        Returns:
        new instance of the component