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

Go to download
package co.spraybot.messagerunner;

import co.spraybot.messagerunner.builders.DataStoreParcelBuilder;

/**
 * @param  The type of data this DataStoreParcel returns as its value
 */
public interface DataStoreParcel extends Parcel {

    /**
     * @return The DataStoreParcelProcessor.Operation that this DataParcel is wanting to have executed
     */
    DataStoreParcelProcessor.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();
    }

}