co.spraybot.messagerunner.ReportStream 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 io.vertx.core.streams.ReadStream;

/**
 * An implementation that is able to parse an arbitrary set of ReportParameters to gather the appropriate information to
 * satisfy the requirements of a given Report. The primary object implemented by developers creating a spraybot-powered
 * chat bot and desire to report on various pieces of business or domain data.
 *
 * @since 0.1.0
 */
public interface ReportStream extends ReadStream {

    /**
     * @return An identifier for this ReportStream that will be used to start the stream.
     */
    String getName();

    /**
     *
     * @param parcel The data specific to this request for a report
     * @return Reference to the object to be used in a fluent manner
     */
    ReportStream startStreaming(ReportStreamParcel parcel);

}