co.spraybot.messagerunner.ProcessorAvailabilityParcel 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.ProcessorAvailabilityParcelBuilder;

import java.util.UUID;

/**
 * A Parcel that should be sent to the Courier when a ParcelProcessor is ready to start or stop processing a specific
 * type of Parcel.
 *
 * @since 0.1.0
 */
public interface ProcessorAvailabilityParcel extends Parcel {

    /**
     * @return The EventBus address that the corresponding ParcelProcessor expects to receive the Parcels it processes.
     */
    UUID getAddress();

    /**
     * @return The type of Parcel that the ParcelProcessor is prepared to have delivered to it.
     */
    Class getParcelType();

    /**
     * @return True or false whether or not the ParcelProcessor is available to process a given type of Parcel.
     */
    boolean isAvailable();

    static ProcessorAvailabilityParcelBuilder builder() {
        return new ProcessorAvailabilityParcelBuilder();
    }

}