co.spraybot.messagerunner.DataStoreParcel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of message-runner Show documentation

A micro-framework to allow easily passing specific Vert.x messages to specific addresses for processing of those messages.

The newest version!

package co.spraybot.messagerunner;

import co.spraybot.messagerunner.builders.DataStoreParcelBuilder;

/**
 * A Parcel that represents some operation that should be performed against a running DataStoreVerticle that allows
 * for the persistence of simple key-value data.
 *
 * @param  The type of data this DataStoreParcel returns as its value
 */
public interface DataStoreParcel extends Parcel {

    /**
     * @return The DataStoreVerticle.Operation that this DataParcel is wanting to have executed
     */
    DataStoreVerticle.Operation getDataStoreOperation();

    /**
     * Possible to return null if the operation for this Parcel does not require a key.
     *
     * @return The key that this Parcel represents
     */
    String getKey();

    /**
     * Possible to return null if the operation for this Parcel does not require a value.
     *
     * @return The value that this Parcel represents
     */
    T getValue();

    Class getValueType();

    /**
     * @return An object following the builder-pattern to easily create DataStoreParcel objects
     */
    static DataStoreParcelBuilder builder() {
        return new DataStoreParcelBuilder();
    }

}