info.freelibrary.iiif.presentation.v3.AnnotationBody Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jiiify-presentation-v3 Show documentation

A Java Library for version 3 of the IIIF Presentation API

There is a newer version: 0.12.4

Show newest version


package info.freelibrary.iiif.presentation.v3;

import java.net.URI;

/**
 * An interface that defines a body of an annotation. The content of body resources is typically "about" the
 * content of the annotation target. There are two superinterfaces for content resources that can be annotation bodies:
 * {@link ContentResource} and {@link EmbeddedResource}.
 */
public interface AnnotationBody> extends ContentResource, EmbeddedResource {

    /**
     * Gets the annotation body ID.
     *
     * @return The annotation body's ID
     */
    @Override
    URI getID();

    /**
     * Sets the annotation body ID from its string form.
     *
     * @param aID An annotation body's ID in string form
     * @return The annotation body
     */
    @Override
    T setID(String aID);

    /**
     * Sets the annotation body ID.
     *
     * @param aID An annotation body's ID
     * @return The annotation body
     */
    @Override
    T setID(URI aID);

    /**
     * Gets the type of annotation body.
     *
     * @return The type of annotation body
     */
    @Override
    String getType();

}