io.annot8.common.implementations.factories.ContentBuilderFactory 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.data.Content;
import io.annot8.core.data.Item;

/**
 * Factory to create an content builder.
 *
 * Typically used in a Item.createContent().
 */
public interface ContentBuilderFactory> {

  /**
   * Create a new builder for the provided item.
   *
   * @param item the item owning this content
   * @param saver the save callback used by builder
   * @return non-null builder
   */
  Content.Builder create(Item item, SaveCallback saver);

  /**
   * Get the class of the data this content holds
   *
   * @return the data class
   */
  Class getDataClass();

  /**
   * Get the content class created.
   *
   * @return content class (being implemented)
   */
  Class getContentClass();
}