info.freelibrary.pairtree.PairtreeObject Maven / Gradle / Ivy

Go to download

package info.freelibrary.pairtree;

import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;

/**
 * A public interface for Pairtree objects.
 */
public interface PairtreeObject {

    /**
     * Tests whether the Pairtree object exists.
     *
     * @param aHandler A {@link io.vertx.core.Handler} with an {@link io.vertx.core.AsyncResult}
     */
    void exists(Handler> aHandler);

    /**
     * Creates the Pairtree object. This fails if the location of the Pairtree object exists and cannot have things
     * written into it (e.g., if it is a file). It doesn't fail if the object already exists and can have things
     * written into it.
     *
     * @param aHandler A {@link io.vertx.core.Handler} with an {@link io.vertx.core.AsyncResult}
     */
    void create(Handler> aHandler);

    /**
     * Deletes the Pairtree object.
     *
     * @param aHandler A {@link io.vertx.core.Handler} with an {@link io.vertx.core.AsyncResult}
     */
    void delete(Handler> aHandler);

    /**
     * Gets the object ID.
     *
     * @return The ID of the Pairtree object
     */
    String getID();

    /**
     * Gets the object path.
     *
     * @return the path of the Pairtree object
     */
    String getPath();

    /**
     * Gets the path of the requested object resource.
     *
     * @param aResourcePath The Pairtree resource which the returned path should represent
     * @return The path of the requested object resource
     */
    String getPath(String aResourcePath);

    /**
     * Puts a resource into the Pairtree object. This overwrites an existing resource at that path.
     *
     * @param aPath A path (relative to the Pairtree object) at which the Buffer should be written
     * @param aBuffer Content to be written into a resource in the Pairtree object
     * @param aHandler To handle the writing of the content into the Pairtree object
     */
    void put(String aPath, Buffer aBuffer, Handler> aHandler);

    /**
     * Gets a resource from the Pairtree object.
     *
     * @param aPath A path (relative to the Pairtree object) from which a Buffer can be retrieved
     * @param aHandler To handle the reading of the content from the Pairtree object into a Buffer
     */
    void get(String aPath, Handler> aHandler);

    /**
     * Checks whether a resource exists in the Pairtree object.
     *
     * @param aPath A path (relative to the Pairtree object) for a resource to be found
     * @param aHandler To handle the finding of a resource in the Pairtree object
     */
    void find(String aPath, Handler> aHandler);

}