Module io.annot8.api
Package io.annot8.api.capabilities

Interface Capabilities

  • public interface Capabilities
    Interface for capturing the capabilities of an Annot8 component

    • Method Detail

      • creates

        Stream<Capability> creates()
        Describes the things (e.g. content, annotations, groups) created by a component
        Returns:
        Stream of Capability objects describing what is created

      • creates

        default <T extends Capability> Stream<T> creates​(Class<T> type)
        Helper method for filtering creates() to a specific type of Capability
        Type Parameters:
        T - Class extending Capability
        Parameters:
        type - The type of capability to filter to
        Returns:
        Stream of Capability objects describing what is created

      • processes

        Stream<Capability> processes()
        Describes the things (e.g. content, annotations, groups) processed by a component
        Returns:
        Stream of Capability objects describing what is processed

      • processes

        default <T extends Capability> Stream<T> processes​(Class<T> type)
        Helper method for filtering processes() to a specific type of Capability
        Type Parameters:
        T - Class extending Capability
        Parameters:
        type - The type of capability to filter to
        Returns:
        Stream of Capability objects describing what is processed

      • deletes

        Stream<Capability> deletes()
        Describes the things (e.g. content, annotations, groups) deleted by a component
        Returns:
        Stream of Capability objects describing what is deleted

      • deletes

        default <T extends Capability> Stream<T> deletes​(Class<T> type)
        Helper method for filtering deletes() to a specific type of Capability
        Type Parameters:
        T - Class extending Capability
        Parameters:
        type - The type of capability to filter to
        Returns:
        Stream of Capability objects describing what is deleted