Module io.annot8.core

Package io.annot8.core.capabilities

This package contains the core interface for capabilities.

Capabilities may be set using annotations on the component, or by the component returning a Capabilities object.

In the case the components' capabilities are configuration dependent, the capabilities should be returned using buildCapabilities on AnnotationCapability. This is typically the case where say the type of an annotation created is a configuration option.

The annotations can be used, but these fixed at development time so can not take into runtime configuration.

You can mix and match the annotation and capabiltiies, they will be fused together by Annot8. It is recommended that the annotation are used where possible as these are clearer to other developers and to the framework.

For clarity capabilities are used as an optimisation (eg for pipeline ordering). Your component should not assume that it will have the resource it has declared a requirement for - it should not crash if requirements are not the case.

Interface Summary

Interface	Description
Capabilities	Base capabilities interface used to describe the capabilities of a component.
Capabilities.Builder	Builder for capabilties

Class Summary

Class	Description
AnnotationCapability	Specification for annotation created, processed or deleted by a component.
ContentCapability	Specification for content created, processed or deleted by a component.
GroupCapability	Specification for group created, processed or deleted by a component.
ResourceCapability	Specification for resource used by a component.

Annotation Types Summary

Annotation Type	Description
CreatesAnnotation	Denotes the annotation types which the component will output.
CreatesAnnotations	Wrapper for repeated CreatesAnnotation.
CreatesContent	Denotes that the component will generate content.
CreatesContents	Wrapper for repeated CreatesContent.
CreatesGroup	Denotes the group types the component may output.
CreatesGroups	Wrapper for repeated CreatesGroup.
DeletesAnnotation	Denotes the annotation types which the component will delete.
DeletesAnnotations
DeletesContent	Denotes that the component will delete content.
DeletesContents	Wrapper for repeated DeletesContent.
DeletesGroup	Denotes the group types the component may delete.
DeletesGroups	Wrapper for repeated DeletesGroup.
ProcessesAnnotation	Denotes the annotation types which are processed by the component.
ProcessesAnnotations	Wrapper for repeated ProcessesAnnotation.
ProcessesContent	Denotes the content classes that the component will act upon
ProcessesContents	Wrapper for repeated ProcessesContent.
ProcessesGroup	Denotes the groups types which are processed by the component.
ProcessesGroups	Wrapper for repeated ProcessesGroup.
UsesResource	The resources which this component may or will use.
UsesResources	Wrapper for repeated UsesResource.