Module io.annot8.core
Package io.annot8.core.capabilities

Interface Capabilities


  • public interface Capabilities
    Base capabilities interface used to describe the capabilities of a component.

    In all cases an empty stream should be returned (rather than null)

    • Method Detail

      • getProcessedAnnotations

        Stream<AnnotationCapability> getProcessedAnnotations​()
        The type of any input annotations (i.e. annotations that must be present before a component can work)
        Returns:
        annotation specifications

      • getCreatedAnnotations

        Stream<AnnotationCapability> getCreatedAnnotations​()
        The type of any output annotations produced by this component
        Returns:
        annotation specifications

      • getDeletedAnnotations

        Stream<AnnotationCapability> getDeletedAnnotations​()
        The type of any output annotations deleted by this component
        Returns:
        annotation specifications

      • getProcessedGroups

        Stream<GroupCapability> getProcessedGroups​()
        The type of any required input annotations (i.e. annotations that must be present before a component can work)
        Returns:
        annotation specifications

      • getCreatedGroups

        Stream<GroupCapability> getCreatedGroups​()
        The type of any output annotations produced by this component
        Returns:
        group specifications

      • getDeletedGroups

        Stream<GroupCapability> getDeletedGroups​()
        The type of any output annotations deleted by this component
        Returns:
        group specifications

      • getCreatedContent

        Stream<ContentCapability> getCreatedContent​()
        The content classes produced by this component, or an empty stream if no new content will be produced
        Returns:
        content specifications

      • getDeletedContent

        Stream<ContentCapability> getDeletedContent​()
        The type of any deleted content
        Returns:
        content specifications

      • getProcessedContent

        Stream<ContentCapability> getProcessedContent​()
        The type of any required content (i.e. content that must be present before a component can work)
        Returns:
        content specifications

      • getUsedResources

        Stream<ResourceCapability> getUsedResources​()
        The resource classes required by this component
        Returns:
        resource specifications