org.openksavi.sponge.event

Interface EventDefinition

public interface EventDefinition

An event definition providing a fluent API for creating and sending events.

Method Summary

Modifier and Type	Method and Description
EventDefinition	description(String description) Sets the event description.
EventDefinition	feature(String name, Object value) Add an event feature.
EventDefinition	features(Map<String,Object> features) Adds event features.
EventDefinition	label(String label) Sets the event label.
Event	make() Returns the event.
EventDefinition	modify(EventDefinitionModifier modifier) Modifies the underlying event.
Event	send() Sends the event to the Input Event Queue.
EventSchedulerEntry	sendAfter(Duration delay) Sends the event to the Input Event Queue after a specified time.
EventSchedulerEntry	sendAfter(Duration delay, Duration interval) Sends the event to the Input Event Queue periodically after a specified time.
EventSchedulerEntry	sendAfter(long delay) Sends the event to the Input Event Queue after a specified time.
EventSchedulerEntry	sendAfter(long delay, long interval) Sends the event to the Input Event Queue periodically after a specified time.
EventSchedulerEntry	sendAt(Instant instant) Sends the event to the Input Event Queue at a specified time.
EventSchedulerEntry	sendAt(Instant instant, Duration interval) Sends the event to the Input Event Queue at a specified time and then periodically.
EventSchedulerEntry	sendAt(long milliseconds) Sends the event to the Input Event Queue at a specified time.
EventSchedulerEntry	sendAt(long milliseconds, long interval) Sends the event to the Input Event Queue at a specified time and then periodically.
EventSchedulerEntry	sendAt(String crontabSpec) Sends the event to the Input Event Queue at a time specified by the crontab spec.
EventSchedulerEntry	sendEvery(Duration interval) Sends the event to the Input Event Queue periodically.
EventSchedulerEntry	sendEvery(long interval) Sends the event to the Input Event Queue periodically.
EventDefinition	set(Map<String,Object> attributes) Sets attributes.
EventDefinition	set(String name, Object value) Sets event attribute.

Method Detail

label

EventDefinition label(String label)

Sets the event label.

Parameters:

label - the event label.

Returns:

this event definition for fluent API.

description

EventDefinition description(String description)

Sets the event description.

Parameters:

description - the event description.

Returns:

this event definition for fluent API.

set

EventDefinition set(String name,
                    Object value)

Sets event attribute.

Parameters:

name - attribute name.

value - attribute value.

Returns:

this event definition for fluent API.

set

EventDefinition set(Map<String,Object> attributes)

Sets attributes.

Parameters:

attributes - the attributes as the map.

Returns:

this event for fluent API.

feature

EventDefinition feature(String name,
                        Object value)

Add an event feature.

Parameters:

name - the feature name.

value - the feature value.

Returns:

this event definition for fluent API.

features

EventDefinition features(Map<String,Object> features)

Adds event features.

Parameters:

features - the features map.

Returns:

this event for fluent API.

modify

EventDefinition modify(EventDefinitionModifier modifier)

Modifies the underlying event.

Parameters:

modifier - event definition modifier.

Returns:

this event definition for fluent API.

send

Event send()

Sends the event to the Input Event Queue. May throw QueueFullException if the Input Event Queue is full.

Returns:

an event.

sendAfter

EventSchedulerEntry sendAfter(long delay)

Sends the event to the Input Event Queue after a specified time.

Parameters:

delay - delay in milliseconds.

Returns:

scheduled event entry.

sendAfter

EventSchedulerEntry sendAfter(long delay,
                              long interval)

Sends the event to the Input Event Queue periodically after a specified time.

Parameters:

delay - delay in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

sendAfter

EventSchedulerEntry sendAfter(Duration delay)

Sends the event to the Input Event Queue after a specified time.

Parameters:

delay - delay as Duration.

Returns:

scheduled event entry.

sendAfter

EventSchedulerEntry sendAfter(Duration delay,
                              Duration interval)

Sends the event to the Input Event Queue periodically after a specified time.

Parameters:

delay - delay as Duration.

interval - interval as Duration.

Returns:

scheduled event entry.

sendAt

EventSchedulerEntry sendAt(long milliseconds)

Sends the event to the Input Event Queue at a specified time.

Parameters:

milliseconds - time in milliseconds.

Returns:

scheduled event entry.

sendAt

EventSchedulerEntry sendAt(long milliseconds,
                           long interval)

Sends the event to the Input Event Queue at a specified time and then periodically.

Parameters:

milliseconds - time in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

sendAt

EventSchedulerEntry sendAt(Instant instant)

Sends the event to the Input Event Queue at a specified time.

Parameters:

instant - time as Instant.

Returns:

scheduled event entry.

sendAt

EventSchedulerEntry sendAt(Instant instant,
                           Duration interval)

Sends the event to the Input Event Queue at a specified time and then periodically.

Parameters:

instant - time as Instant.

interval - interval as Duration.

Returns:

scheduled event entry.

sendAt

EventSchedulerEntry sendAt(String crontabSpec)

Sends the event to the Input Event Queue at a time specified by the crontab spec.

Parameters:

crontabSpec - crontab spec.

Returns:

scheduled event entry.

sendEvery

EventSchedulerEntry sendEvery(long interval)

Sends the event to the Input Event Queue periodically.

Parameters:

interval - interval in milliseconds.

Returns:

scheduled event entry.

sendEvery

EventSchedulerEntry sendEvery(Duration interval)

Sends the event to the Input Event Queue periodically.

Parameters:

interval - interval as Duration.

Returns:

scheduled event entry.

make

Event make()

Returns the event.

Returns:

the event.