io.annot8.api.components.Processor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of annot8-api Show documentation

Core API interfaces for the Annot8 project

There is a newer version: 1.2

/* Annot8 (annot8.io) - Licensed under Apache-2.0. */
package io.annot8.api.components;

import io.annot8.api.components.responses.ProcessorResponse;
import io.annot8.api.data.Item;

/**
 * Base processor interface from which all processors extend.
 *
 * Processors do work on an item, such as adding new annotations, or creating new content.
 */
public interface Processor extends Annot8Component {

  /**
   * Process the given item
   *
   * @param item the item to process
   * @return status of processing
   */
  ProcessorResponse process(final Item item);
}