Index (Annot8 Core 0.2.0 API)

A B C D E F G H I K L M N O P R S T U V W

A

add(Map<String, Object>) - Method in interface io.annot8.core.properties.MutableProperties: Add all properties from the given map, overwriting values where they already exist
AlreadyExistsException - Exception in io.annot8.core.exceptions: Exception indicating that an attempt has been made to create something that already exists, i.e.
AlreadyExistsException(String) - Constructor for exception io.annot8.core.exceptions.AlreadyExistsException: Create an exception with the given message
AlreadyExistsException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.AlreadyExistsException: Create an exception with the given message and a root cause
Annot8Component - Interface in io.annot8.core.components: Base interface from which all other Annot8 components extend.
Annot8Exception - Exception in io.annot8.core.exceptions: Base class for all Annot8 exceptions
Annot8Exception(String) - Constructor for exception io.annot8.core.exceptions.Annot8Exception: Create an exception with the given message
Annot8Exception(String, Throwable) - Constructor for exception io.annot8.core.exceptions.Annot8Exception: Create an exception with the given message and a root cause
Annot8RuntimeException - Exception in io.annot8.core.exceptions: Base class for all Annot8 runtime exceptions
Annot8RuntimeException(String) - Constructor for exception io.annot8.core.exceptions.Annot8RuntimeException: Create an exception with the given message
Annot8RuntimeException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.Annot8RuntimeException: Create an exception with the given message and a root cause
Annotation - Interface in io.annot8.core.annotations: Base annotation interface from which all other annotations extend.
Annotation.Builder - Interface in io.annot8.core.annotations: Builder interface to create (immutable) Annotation classes
AnnotationCapability - Class in io.annot8.core.capabilities: Specification for annotation created, processed or deleted by a component.
AnnotationCapability(CreatesAnnotation) - Constructor for class io.annot8.core.capabilities.AnnotationCapability: Create from CreatesAnnotation
AnnotationCapability(DeletesAnnotation) - Constructor for class io.annot8.core.capabilities.AnnotationCapability: Create from DeletesAnnotation
AnnotationCapability(ProcessesAnnotation) - Constructor for class io.annot8.core.capabilities.AnnotationCapability: Create from ProcessesAnnotation
AnnotationCapability(String, Class<? extends Bounds>, boolean) - Constructor for class io.annot8.core.capabilities.AnnotationCapability: Create from fields
AnnotationReference - Interface in io.annot8.core.references: A reference to an annotation.
AnnotationStore - Interface in io.annot8.core.stores: Base annotations interface from which all other annotation stores extend.

B

BadConfigurationException - Exception in io.annot8.core.exceptions: Exception indicating that an unacceptable configuration has been provided to a component, or required configuration information is missing.
BadConfigurationException(String) - Constructor for exception io.annot8.core.exceptions.BadConfigurationException: Create an exception with the given message
BadConfigurationException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.BadConfigurationException: Create an exception with the given message and a root cause
BaseItem - Interface in io.annot8.core.data: Base item interface from which all item implementations extend.
Bounds - Interface in io.annot8.core.bounds: Base bounds interface from which all other bounds extend.
build() - Method in interface io.annot8.core.helpers.builders.WithBuild: Save content of the builder into an object
buildCapabilities(Capabilities.Builder) - Method in interface io.annot8.core.components.Annot8Component: Add the capabilities of this component.

C

Capabilities - Interface in io.annot8.core.capabilities: Base capabilities interface used to describe the capabilities of a component.
Capabilities.Builder - Interface in io.annot8.core.capabilities: Builder for capabilties
close() - Method in interface io.annot8.core.components.Annot8Component
configure(Context) - Method in interface io.annot8.core.components.Annot8Component: Configure this component using information from the given context.
containsAnnotation(Annotation) - Method in interface io.annot8.core.annotations.Group: Check if the annotation is included in the group.
containsRole(String) - Method in interface io.annot8.core.annotations.Group: Check if role is included in the group
Content<D> - Interface in io.annot8.core.data: Base content interface from which all content implementations extend.
Content.Builder<A extends Content<D>,D> - Interface in io.annot8.core.data: Builder interface to create (immutable) Content classes
ContentCapability - Class in io.annot8.core.capabilities: Specification for content created, processed or deleted by a component.
ContentCapability(CreatesContent) - Constructor for class io.annot8.core.capabilities.ContentCapability: Create from CreatesContent
ContentCapability(DeletesContent) - Constructor for class io.annot8.core.capabilities.ContentCapability: Create from DeletesContent
ContentCapability(ProcessesContent) - Constructor for class io.annot8.core.capabilities.ContentCapability: Create from ProcessesContent
ContentCapability(Class<? extends Content<?>>, boolean) - Constructor for class io.annot8.core.capabilities.ContentCapability: Create from details
Context - Interface in io.annot8.core.context: Base context interface from which all context implementations extend.
copy(Annotation) - Method in interface io.annot8.core.stores.AnnotationStore: Clone an existing annotation to create a new annotation
copy(Group) - Method in interface io.annot8.core.stores.GroupStore: Clone an existing group to create a new group
create() - Method in interface io.annot8.core.data.Item: Create a child item of this item, which will be processed independently
create() - Method in interface io.annot8.core.data.ItemFactory: Create a new item
create() - Method in interface io.annot8.core.stores.AnnotationStore: Get a builder to create a new annotation
create() - Method in interface io.annot8.core.stores.GroupStore: Create a new group
create(Class<C>) - Method in interface io.annot8.core.data.BaseItem: Create a new content builder to generate content.
createsAnnotation(AnnotationCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create an annotation
createsAnnotation(String, Class<? extends Bounds>) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create an annotation
CreatesAnnotation - Annotation Type in io.annot8.core.capabilities: Denotes the annotation types which the component will output.
CreatesAnnotations - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated CreatesAnnotation.
createsContent(ContentCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create a content type
createsContent(Class<? extends Content<?>>) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create a type of content
CreatesContent - Annotation Type in io.annot8.core.capabilities: Denotes that the component will generate content.
CreatesContents - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated CreatesContent.
createsGroup(GroupCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create a group
createsGroup(String) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will create a group
CreatesGroup - Annotation Type in io.annot8.core.capabilities: Denotes the group types the component may output.
CreatesGroups - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated CreatesGroup.

D

delete(Annotation) - Method in interface io.annot8.core.stores.AnnotationStore: Delete an annotation from the store
delete(Group) - Method in interface io.annot8.core.stores.GroupStore: Delete a group from the store
delete(Collection<Annotation>) - Method in interface io.annot8.core.stores.AnnotationStore: Delete a collection of annotations from the store
delete(Collection<Group>) - Method in interface io.annot8.core.stores.GroupStore: Delete a collection of groups from the store
deleteAll() - Method in interface io.annot8.core.stores.AnnotationStore: Delete all annotations from the store
deleteAll() - Method in interface io.annot8.core.stores.GroupStore: Delete all groups from the store
deletesAnnotation(AnnotationCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete an annotation
deletesAnnotation(String, Class<? extends Bounds>) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete an annotation
DeletesAnnotation - Annotation Type in io.annot8.core.capabilities: Denotes the annotation types which the component will delete.
DeletesAnnotations - Annotation Type in io.annot8.core.capabilities
deletesContent(ContentCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete a content type
deletesContent(Class<? extends Content<?>>) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete a type of content
DeletesContent - Annotation Type in io.annot8.core.capabilities: Denotes that the component will delete content.
DeletesContents - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated DeletesContent.
deletesGroup(GroupCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete a group
deletesGroup(String) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will delete a group
DeletesGroup - Annotation Type in io.annot8.core.capabilities: Denotes the group types the component may delete.
DeletesGroups - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated DeletesGroup.
discard() - Method in interface io.annot8.core.data.BaseItem: Stop processing this item any further.
done() - Static method in interface io.annot8.core.components.responses.SourceResponse: Source is now out of items
DONE - io.annot8.core.components.responses.SourceResponse.Status: Indicates that the source has been exhausted, and will never return any new items.

E

edit(Annotation) - Method in interface io.annot8.core.stores.AnnotationStore: Edit an annotation (saving will replace the old version)
edit(Group) - Method in interface io.annot8.core.stores.GroupStore: Edit an existing group, saving will replace it
empty() - Static method in interface io.annot8.core.components.responses.SourceResponse: The Source is currently empty
EMPTY - io.annot8.core.components.responses.SourceResponse.Status: Indicates that the source is temporarily empty, but that it may have new items in the future.
EmptySettings - Class in io.annot8.core.settings: An empty Settings class.
equals(Properties, Properties) - Static method in interface io.annot8.core.properties.Properties
equals(Object) - Method in class io.annot8.core.capabilities.AnnotationCapability
equals(Object) - Method in class io.annot8.core.capabilities.ContentCapability
equals(Object) - Method in class io.annot8.core.capabilities.GroupCapability
equals(Object) - Method in class io.annot8.core.capabilities.ResourceCapability
equals(Object) - Method in class io.annot8.core.components.responses.ProcessorResponse.ProcessorResponseBuilder
equals(Object) - Method in class io.annot8.core.components.responses.SourceResponse.SourceResponseBuilder

F

from(A) - Method in interface io.annot8.core.helpers.builders.WithFromBuilder: Add the informaton from the provided param

G

get(String) - Method in interface io.annot8.core.properties.Properties: Get the proprety value
getAll() - Method in interface io.annot8.core.properties.Properties: Get the properties as a map
getAll() - Method in interface io.annot8.core.stores.AnnotationStore: Get all annotations currently held in this store
getAll() - Method in interface io.annot8.core.stores.GroupStore: Get all groups
getAll(Class<T>) - Method in interface io.annot8.core.properties.Properties: Get all properties which have a value instance of class
getAnnotationId() - Method in interface io.annot8.core.references.AnnotationReference: The annotation's id
getAnnotations() - Method in interface io.annot8.core.annotations.Group: The roles with the associated annotations in this group
getAnnotations() - Method in interface io.annot8.core.data.Content: The annotation store for this content
getAnnotations(String) - Method in interface io.annot8.core.annotations.Group: All the annotations in this group with the specified role
getAnnotationsForContent(Content) - Method in interface io.annot8.core.annotations.Group: Return all the annotations in this group for the specified content.
getAnnotationsForContentAndRole(Content, String) - Method in interface io.annot8.core.annotations.Group: Return all the annotations in this group for the specified content and role.
getBounds() - Method in interface io.annot8.core.annotations.Annotation: Get the Bounds associated with this annotation
getBounds() - Method in class io.annot8.core.capabilities.AnnotationCapability: Get the bounds created/deleted/processed
getBounds(Class<B>) - Method in interface io.annot8.core.annotations.Annotation: Get the Bounds associated with this annotation casting it to the bounds provided (if it is of that type / subtype).
getBuilder() - Method in interface io.annot8.core.stores.AnnotationStore: Get a new annotation builder
getBuilder() - Method in interface io.annot8.core.stores.GroupStore: Create a new group builder
getByBounds(Class<B>) - Method in interface io.annot8.core.stores.AnnotationStore: Get all annotations of a given bounds currently held in this store
getByBoundsAndType(Class<B>, String) - Method in interface io.annot8.core.stores.AnnotationStore: Get all annotations of a given bounds and type currently held in this store
getById(String) - Method in interface io.annot8.core.stores.AnnotationStore: Get the annotation with the given ID, if it is currently held in this store
getById(String) - Method in interface io.annot8.core.stores.GroupStore: Get the group with the given ID, if it is currently held in this store
getByType(String) - Method in interface io.annot8.core.stores.AnnotationStore: Get all annotations of a given type currently held in this store
getByType(String) - Method in interface io.annot8.core.stores.GroupStore: Get all groups of a given type currently held in this store
getContent(String) - Method in interface io.annot8.core.data.BaseItem: The content object for the specified id
getContentByName(String) - Method in interface io.annot8.core.data.BaseItem: The content object for the specified name
getContentClass() - Method in interface io.annot8.core.data.Content: The top level content interface this object implements
getContentId() - Method in interface io.annot8.core.annotations.Annotation: Get the id of the Content to which this annotation refers
getContentId() - Method in interface io.annot8.core.references.AnnotationReference: The id of the content to which this annotation belongs.
getContents() - Method in interface io.annot8.core.data.BaseItem: All content objects contained within this item
getContents(Class<T>) - Method in interface io.annot8.core.data.BaseItem: All content objects of the specified class contained within this item
getCreatedAnnotations() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any output annotations produced by this component
getCreatedContent() - Method in interface io.annot8.core.capabilities.Capabilities: The content classes produced by this component, or an empty stream if no new content will be produced
getCreatedGroups() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any output annotations produced by this component
getData() - Method in interface io.annot8.core.data.Content: The data associated with this content object
getData(C) - Method in interface io.annot8.core.bounds.Bounds: Get the subset of data which is covered by these bounds, returning the data in the native format of the Content.
getData(C, Class<R>) - Method in interface io.annot8.core.bounds.Bounds: Get the subset of data which is covered by these bounds.
getDataClass() - Method in interface io.annot8.core.data.Content: The class of the data stored in this Content object
getDeletedAnnotations() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any output annotations deleted by this component
getDeletedContent() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any deleted content
getDeletedGroups() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any output annotations deleted by this component
getGroupId() - Method in interface io.annot8.core.references.GroupReference: Get the id of the group which is referenced
getGroups() - Method in interface io.annot8.core.helpers.WithGroups: Get the group store
getId() - Method in interface io.annot8.core.helpers.WithId: Get the ID
getInstance() - Static method in class io.annot8.core.settings.EmptySettings: Get the instance
getName() - Method in interface io.annot8.core.helpers.WithName: Get the name
getObjectOrDefault(String, Object) - Method in interface io.annot8.core.properties.Properties: Get the value or use a default if missing
getOrDefault(String, T) - Method in interface io.annot8.core.properties.Properties: Get a specific class at the key, or use the default
getParent() - Method in interface io.annot8.core.data.BaseItem
getProcessedAnnotations() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any input annotations (i.e.
getProcessedContent() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any required content (i.e.
getProcessedGroups() - Method in interface io.annot8.core.capabilities.Capabilities: The type of any required input annotations (i.e.
getProperties() - Method in interface io.annot8.core.helpers.WithMutableProperties: Get the properties
getProperties() - Method in interface io.annot8.core.helpers.WithProperties: Get the properties
getProperty(String, Class<T>) - Method in interface io.annot8.core.properties.Properties: Get the property value of specified class
getReferences() - Method in interface io.annot8.core.annotations.Group: The associated annotations references in this group
getResource(Class<T>) - Method in interface io.annot8.core.context.Context: Return any resource (if there is one) of the specified type
getResource(String, Class<T>) - Method in interface io.annot8.core.context.Context: Find the resource of the given type associated with the given key
getResourceKeys() - Method in interface io.annot8.core.context.Context: List all the resource keys contained within this context
getResourceKeys(Class<? extends Resource>) - Method in interface io.annot8.core.context.Context: List all the resource keys contained within this context that are of the specified type
getResources(Class<T>) - Method in interface io.annot8.core.context.Context: Return all resources of the specified type
getRole(Annotation) - Method in interface io.annot8.core.annotations.Group: Get the role of a specific annotation in this group
getRoles() - Method in interface io.annot8.core.annotations.Group: Return all the roles currently associated with annotations in this group
getSettings() - Method in interface io.annot8.core.context.Context: The settings for the component that this context is being passed to.
getSettings(Class<T>) - Method in interface io.annot8.core.context.Context: Return a settings object as the given class.
getSettings(Class<T>, T) - Method in interface io.annot8.core.context.Context: Return a settings object as the given class, attempting to create a new settings object of that class if the currently given settings are not of this class.
getStatus() - Method in interface io.annot8.core.components.responses.ProcessorResponse: Return the status associated with this response
getStatus() - Method in class io.annot8.core.components.responses.ProcessorResponse.ProcessorResponseBuilder
getStatus() - Method in interface io.annot8.core.components.responses.SourceResponse: Return the status associated with this response
getStatus() - Method in class io.annot8.core.components.responses.SourceResponse.SourceResponseBuilder
getType() - Method in class io.annot8.core.capabilities.AnnotationCapability: Get the annotation type created/deleted/processed
getType() - Method in class io.annot8.core.capabilities.ContentCapability: Get the content type created/deleted/processed
getType() - Method in class io.annot8.core.capabilities.GroupCapability: Get the group type created/deleted/processed
getType() - Method in class io.annot8.core.capabilities.ResourceCapability: Get the resource type created/deleted/processed
getType() - Method in interface io.annot8.core.helpers.WithType: Get the type
getUsedResources() - Method in interface io.annot8.core.capabilities.Capabilities: The resource classes required by this component
Group - Interface in io.annot8.core.annotations: Base annotation interface from which all other annotations extend.
Group.Builder - Interface in io.annot8.core.annotations: Builder interface to create (immutable) Group classes
GroupCapability - Class in io.annot8.core.capabilities: Specification for group created, processed or deleted by a component.
GroupCapability(CreatesGroup) - Constructor for class io.annot8.core.capabilities.GroupCapability: Create from CreatesGroup
GroupCapability(DeletesGroup) - Constructor for class io.annot8.core.capabilities.GroupCapability: Create from DeletesGroup
GroupCapability(ProcessesGroup) - Constructor for class io.annot8.core.capabilities.GroupCapability: Create from ProcessesGroup
GroupCapability(String, boolean) - Constructor for class io.annot8.core.capabilities.GroupCapability: Create from details
GroupReference - Interface in io.annot8.core.references: A reference to a group.
GroupStore - Interface in io.annot8.core.stores: Base groups interface from which all other group stores extend.

H

has(String) - Method in interface io.annot8.core.properties.Properties: Check if a key exists
has(String, Class<?>) - Method in interface io.annot8.core.properties.Properties: Check if key existing and its value is of a specific class
hasContentOfName(String) - Method in interface io.annot8.core.data.BaseItem: Check if content name exists
hashCode() - Method in class io.annot8.core.capabilities.AnnotationCapability
hashCode() - Method in class io.annot8.core.capabilities.ContentCapability
hashCode() - Method in class io.annot8.core.capabilities.GroupCapability
hashCode() - Method in class io.annot8.core.capabilities.ResourceCapability
hashCode() - Method in class io.annot8.core.components.responses.ProcessorResponse.ProcessorResponseBuilder
hashCode() - Method in class io.annot8.core.components.responses.SourceResponse.SourceResponseBuilder
hashCode(Properties) - Static method in interface io.annot8.core.properties.Properties
hasParent() - Method in interface io.annot8.core.data.BaseItem

I

ImmutableProperties - Interface in io.annot8.core.properties: Base immutable properties interface from which all other immutable properties extend.
ImmutableProperties.Builder - Interface in io.annot8.core.properties: Builder interface to create (immutable) properties classes
IncompleteException - Exception in io.annot8.core.exceptions: Exception indicating that a builder has been asked to create a new object without having been given all the required information
IncompleteException(String) - Constructor for exception io.annot8.core.exceptions.IncompleteException: Create an exception with the given message
IncompleteException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.IncompleteException: Create an exception with the given message and a root cause
InvalidBoundsException - Exception in io.annot8.core.exceptions: Runtime exception indicating that an attempt to either create or use an invalid Bounds object has been performed.
InvalidBoundsException(String) - Constructor for exception io.annot8.core.exceptions.InvalidBoundsException: Create an exception with the given message
InvalidBoundsException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.InvalidBoundsException: Create an exception with the given message and a root cause
io.annot8.core - module io.annot8.core: This module contains the core interfaces for use within Annot8.
io.annot8.core.annotations - package io.annot8.core.annotations: This package contains the core interfaces for annotations and groups of annotations.
io.annot8.core.bounds - package io.annot8.core.bounds: This package contains the core interface for bounds.
io.annot8.core.capabilities - package io.annot8.core.capabilities: This package contains the core interface for capabilities.
io.annot8.core.components - package io.annot8.core.components: This package contains the core interface for components.
io.annot8.core.components.responses - package io.annot8.core.components.responses: This package contains the response objects returned by some components.
io.annot8.core.context - package io.annot8.core.context: This package contains the core interface for the context object.
io.annot8.core.data - package io.annot8.core.data: This package contains the core data objects used by Annot8
io.annot8.core.exceptions - package io.annot8.core.exceptions: This package contains the exceptions used by Annot8
io.annot8.core.helpers - package io.annot8.core.helpers: This package contains helper interfaces used internally by the Annot8 core module.
io.annot8.core.helpers.builders - package io.annot8.core.helpers.builders: This package contains helper interfaces used internally by builders within the Annot8 core module
io.annot8.core.properties - package io.annot8.core.properties: This package contains the core interface for properties.
io.annot8.core.references - package io.annot8.core.references
io.annot8.core.settings - package io.annot8.core.settings: This package contains the core interface and annotations for the settings objects.
io.annot8.core.stores - package io.annot8.core.stores: This package contains the core interfaces for store objects
isDiscarded() - Method in interface io.annot8.core.data.BaseItem: If this item is to be discarded at the end of current processing
isOptional() - Method in class io.annot8.core.capabilities.AnnotationCapability: Is the annotation defined by this object optionally (required for processing, created, deleted)
isOptional() - Method in class io.annot8.core.capabilities.ContentCapability: Is the content defined by this object optionally (required for processing, created, deleted)
isOptional() - Method in class io.annot8.core.capabilities.GroupCapability: Is the group defined by this object optionally (required for processing, created, deleted)
isOptional() - Method in class io.annot8.core.capabilities.ResourceCapability: Is the resource defined by this object optionally used (ie used is available)
isValid(C) - Method in interface io.annot8.core.bounds.Bounds: Are these bounds valid for the provided content?
Item - Interface in io.annot8.core.data: Item interface used by components.
ITEM_ERROR - io.annot8.core.components.responses.ProcessorResponse.Status: Indicates that an error happened whilst processing this item, but that it should be possible to process other items.
itemError() - Static method in interface io.annot8.core.components.responses.ProcessorResponse: Create an ITEM_ERROR response
ItemFactory - Interface in io.annot8.core.data: Factory to create new items.

K

keys() - Method in interface io.annot8.core.properties.Properties: Get all keys

L

listKeys(Class<T>) - Method in interface io.annot8.core.properties.Properties: Get all keys which have the value an instance of class
listNames() - Method in interface io.annot8.core.data.BaseItem: The names of the content objects currently held within this item

M

merge(Capabilities) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Merge another set of existing capabilities.
MissingResourceException - Exception in io.annot8.core.exceptions: Exception indicating a required resource has not been provided to a component
MissingResourceException(String) - Constructor for exception io.annot8.core.exceptions.MissingResourceException: Create an exception with the given message
MissingResourceException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.MissingResourceException: Create an exception with the given message and a root cause
MutableProperties - Interface in io.annot8.core.properties: Base mutable properties interface from which all other mutable properties extend.

N

newId() - Method in interface io.annot8.core.helpers.builders.WithNewIdBuilder: Assign a new id to the built object

O

ok() - Static method in interface io.annot8.core.components.responses.ProcessorResponse: Create an OK response with no new items
ok() - Static method in interface io.annot8.core.components.responses.SourceResponse: Create source read items normally
OK - io.annot8.core.components.responses.ProcessorResponse.Status: Indicates that the processor has worked successfully
OK - io.annot8.core.components.responses.SourceResponse.Status: Indicates that the source found new items, and that the pipeline may ask the source for new items again as soon as it is ready.

P

Parameter - Annotation Type in io.annot8.core.settings: Declares a parameter within a settings class.
process(Item) - Method in interface io.annot8.core.helpers.WithProcessItem: Process the given item
processesAnnotation(AnnotationCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process an annotation
processesAnnotation(String, Class<? extends Bounds>, boolean) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process an annotation
ProcessesAnnotation - Annotation Type in io.annot8.core.capabilities: Denotes the annotation types which are processed by the component.
ProcessesAnnotations - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated ProcessesAnnotation.
processesContent(ContentCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process a content type
processesContent(Class<? extends Content<?>>, boolean) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process a type of content
ProcessesContent - Annotation Type in io.annot8.core.capabilities: Denotes the content classes that the component will act upon
ProcessesContents - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated ProcessesContent.
processesGroup(GroupCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process a group
processesGroup(String, boolean) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will process a group
ProcessesGroup - Annotation Type in io.annot8.core.capabilities: Denotes the groups types which are processed by the component.
ProcessesGroups - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated ProcessesGroup.
processingError() - Static method in interface io.annot8.core.components.responses.ProcessorResponse: Create a PIPELINE_ERROR response
ProcessingException - Exception in io.annot8.core.exceptions: Generic exception thrown if there is an error during processing of a document.
ProcessingException(String) - Constructor for exception io.annot8.core.exceptions.ProcessingException: Create an exception with the given message
ProcessingException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.ProcessingException: Create an exception with the given message and a root cause
Processor - Interface in io.annot8.core.components: Base processor interface from which all processors extend.
PROCESSOR_ERROR - io.annot8.core.components.responses.ProcessorResponse.Status: Indicates that an error happened whilst processing this item, and that it will prevent other items from being processed.
ProcessorResponse - Interface in io.annot8.core.components.responses: Class to hold the response from a processor.
ProcessorResponse.ProcessorResponseBuilder - Class in io.annot8.core.components.responses
ProcessorResponse.Status - Enum in io.annot8.core.components.responses: Response status returned by the processor
ProcessorResponseBuilder(ProcessorResponse.Status) - Constructor for class io.annot8.core.components.responses.ProcessorResponse.ProcessorResponseBuilder
Properties - Interface in io.annot8.core.properties: Base properties interface from which all other properties objects/interfaces extend.

R

read(ItemFactory) - Method in interface io.annot8.core.components.Source: Read from the data source and return new items if found
remove(String) - Method in interface io.annot8.core.properties.MutableProperties: Remove the property for the specified key, and return it's object (if it exists)
remove(Collection<String>) - Method in interface io.annot8.core.properties.MutableProperties: Remove all properties that match the given keys
removeAll() - Method in interface io.annot8.core.properties.MutableProperties: Return a map of all properties
removeContent(String) - Method in interface io.annot8.core.data.BaseItem: Remove the specified content object from this item
Resource - Interface in io.annot8.core.components: A reusable resource (for example a database connection, or a preloaded dataset) that can be used by other components.
ResourceCapability - Class in io.annot8.core.capabilities: Specification for resource used by a component.
ResourceCapability(UsesResource) - Constructor for class io.annot8.core.capabilities.ResourceCapability: Create from UsesResource.
ResourceCapability(Class<? extends Resource>, boolean) - Constructor for class io.annot8.core.capabilities.ResourceCapability: Create from details

S

sameAnnotation(Annotation) - Method in interface io.annot8.core.annotations.Annotation: Do two instances represent the same underlying annotations?
sameGroup(Group) - Method in interface io.annot8.core.annotations.Group: Do two instances represent the same underlying group?
save() - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Save content of the builder into an capabilities
save() - Method in interface io.annot8.core.helpers.builders.WithSave: Save content of the builder into an object
set(String, Object) - Method in interface io.annot8.core.properties.MutableProperties: Set the property value for the specified key
set(Map<String, Object>) - Method in interface io.annot8.core.properties.MutableProperties: Set the current properties to be equal to the map
Settings - Interface in io.annot8.core.settings: Base settings interface from which all other settings extend.
SettingsClass - Annotation Type in io.annot8.core.settings: Specify which class is to be used for settings by a component.
SettingsClasses - Annotation Type in io.annot8.core.settings: Wrapper for repeated SettingsClass.
Source - Interface in io.annot8.core.components: Base processor interface from which all sources extend.
SOURCE_ERROR - io.annot8.core.components.responses.SourceResponse.Status: Indicates that an error occurred with the source.
sourceError() - Static method in interface io.annot8.core.components.responses.SourceResponse: There was an error reading from the Source
SourceResponse - Interface in io.annot8.core.components.responses: Class to hold the response from a source.
SourceResponse.SourceResponseBuilder - Class in io.annot8.core.components.responses
SourceResponse.Status - Enum in io.annot8.core.components.responses: Response status returned by the source
SourceResponseBuilder(SourceResponse.Status) - Constructor for class io.annot8.core.components.responses.SourceResponse.SourceResponseBuilder

T

toAnnotation() - Method in interface io.annot8.core.references.AnnotationReference: Convert the reference to an annotations.
toAnnotations(Stream<AnnotationReference>) - Static method in interface io.annot8.core.references.AnnotationReference: Convert a stream of annotation references to annotations
toGroup() - Method in interface io.annot8.core.references.GroupReference: Convert a reference to a group instance.
toGroups(Stream<GroupReference>) - Static method in interface io.annot8.core.references.GroupReference: Convert a stream of group references to groups
toString() - Method in class io.annot8.core.components.responses.ProcessorResponse.ProcessorResponseBuilder
toString() - Method in class io.annot8.core.components.responses.SourceResponse.SourceResponseBuilder

U

UnsupportedContentException - Exception in io.annot8.core.exceptions: Exception indicating that the content type is not supported
UnsupportedContentException(String) - Constructor for exception io.annot8.core.exceptions.UnsupportedContentException: Create an exception with the given message
UnsupportedContentException(String, Throwable) - Constructor for exception io.annot8.core.exceptions.UnsupportedContentException: Create an exception with the given message and a root cause
usesResource(ResourceCapability) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will use a resource
usesResource(Class<? extends Resource>, boolean) - Method in interface io.annot8.core.capabilities.Capabilities.Builder: Declare that the component will use a resource
UsesResource - Annotation Type in io.annot8.core.capabilities: The resources which this component may or will use.
UsesResources - Annotation Type in io.annot8.core.capabilities: Wrapper for repeated UsesResource.

V

validate() - Method in class io.annot8.core.settings.EmptySettings
validate() - Method in interface io.annot8.core.settings.Settings: Check that the settings are sufficiently complete to allow them to be used.
valueOf(String) - Static method in enum io.annot8.core.components.responses.ProcessorResponse.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.annot8.core.components.responses.SourceResponse.Status: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.annot8.core.components.responses.ProcessorResponse.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.annot8.core.components.responses.SourceResponse.Status: Returns an array containing the constants of this enum type, in the order they are declared.

W

withAnnotation(String, Annotation) - Method in interface io.annot8.core.annotations.Group.Builder: Add an annotation to this group with the specified role.
withBounds(Bounds) - Method in interface io.annot8.core.annotations.Annotation.Builder: Set the Bounds associated with this annotation
WithBuild<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder has a build method.
withData(D) - Method in interface io.annot8.core.data.Content.Builder: Set the data for this content object
withData(Supplier<D>) - Method in interface io.annot8.core.data.Content.Builder: Set the data for this content object, accessed via a supplier
WithFromBuilder<E,A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder can create an object based off an existing object of the same type
WithGroups - Interface in io.annot8.core.helpers: Helper interface to indicate that a class supports GroupStore
withId(String) - Method in interface io.annot8.core.helpers.builders.WithIdBuilder: Set the id
WithId - Interface in io.annot8.core.helpers: Helper interface to indicate that a class has an ID
WithIdBuilder<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder should assign a provided ID to an object
WithMutableProperties - Interface in io.annot8.core.helpers: Helper interface to indicate that a class supports MutableProperties
withName(String) - Method in interface io.annot8.core.data.Content.Builder: Set the name of this content object
WithName - Interface in io.annot8.core.helpers: Helper interface to indicate that a class has an name
WithNewIdBuilder<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder should assign a new ID to an object
withoutProperty(String) - Method in interface io.annot8.core.helpers.builders.WithPropertiesBuilder: Remove a property
withoutProperty(String, Object) - Method in interface io.annot8.core.helpers.builders.WithPropertiesBuilder: Remove a property with matching key and value
WithProcessItem - Interface in io.annot8.core.helpers
withProperties(Properties) - Method in interface io.annot8.core.helpers.builders.WithPropertiesBuilder: Add in existing properties
WithProperties - Interface in io.annot8.core.helpers: Helper interface to indicate that a class supports ImmutableProperties
WithPropertiesBuilder<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder should support adding properties to an object
withProperty(String, Object) - Method in interface io.annot8.core.helpers.builders.WithPropertiesBuilder: Add a property
WithSave<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder has a save method.
withType(String) - Method in interface io.annot8.core.helpers.builders.WithTypeBuilder: Assign a type to the builder
WithType - Interface in io.annot8.core.helpers: Helper interface to indicate that a class has a type
WithTypeBuilder<A> - Interface in io.annot8.core.helpers.builders: Helper interface to indicate that a builder should support setting a type on an object

A B C D E F G H I K L M N O P R S T U V W