info.freelibrary.iiif.presentation.v3.EmbeddedResource 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 resources that are embedded in an annotation's body. Examples include: {@link TextualBody}
 * and {@link CanvasContent}.
 *
 * @param  The type of embedded resource
 */
public interface EmbeddedResource> {

    /**
     * Gets the embedded resource ID.
     *
     * @return The embedded resource's ID
     */
    URI getID();

    /**
     * Sets the embedded resource ID from its string form.
     *
     * @param aID A embedded resource's ID in string form
     * @return The embedded resource
     */
    T setID(String aID);

    /**
     * Sets the embedded resource ID.
     *
     * @param aID A embedded resource's ID
     * @return The embedded resource
     */
    T setID(URI aID);

    /**
     * Gets the type of the embedded resource.
     *
     * @return The type of embedded resource
     */
    String getType();

}