io.annot8.common.implementations.factories.AnnotationBuilderFactory Maven / Gradle / Ivy

Go to download

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

Common functionality used by Annot8 implementations

There is a newer version: 0.2.0

Show newest version

/* Annot8 (annot8.io) - Licensed under Apache-2.0. */
package io.annot8.common.implementations.factories;

import io.annot8.common.implementations.stores.SaveCallback;
import io.annot8.core.annotations.Annotation;
import io.annot8.core.stores.AnnotationStore;

/**
 * Factory to create an annotation builder.
 *
 * Typically used in an AnnotationStore.getBuilder().
 */
@FunctionalInterface
public interface AnnotationBuilderFactory {

  /**
   * Create a new builder for the provided parameters.
   *
   * Most implementation will simply need the store parameter to allow save on save.
   *
   * @param content the content id
   * @param store the annotation store to use
   * @param saver save callback (used by the builder)
   * @return non-null builder
   */
  Annotation.Builder create(
      String content, AnnotationStore store, SaveCallback saver);
}