Package org.jgrapes.core

Class NamedEvent<T>

java.lang.Object

org.jgrapes.core.internal.EventBase<T>

org.jgrapes.core.Event<T>

org.jgrapes.core.NamedEvent<T>

All Implemented Interfaces:

Future<T>, Associator, Eligible

public final class NamedEvent<T>
extends Event<T>

A class for events using a simple name as the event’s kind.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
NamedEvent(String kind)	Creates a new named event with the given name.

Method Summary

Modifier and Type	Method	Description
Map<Object,Object>	data()	Returns a map with data that belongs to the event.
Object	defaultCriterion()	Returns the kind of the event as the String passed to the constructor.
boolean	isEligibleFor(Object criterion)	Returns true if the criterion is Event.class (representing “any event”) or if the criterion is a String equal to this event’s kind (the String passed to the constructor).
String	toString()

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, forChannels, get, get, handled, handlingError, isCancelled, isDone, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

NamedEvent

public NamedEvent(String kind)

Creates a new named event with the given name.

Parameters:

kind - the event’s kind

Method Details

defaultCriterion

public Object defaultCriterion()

Returns the kind of the event as the String passed to the constructor.

Specified by:

defaultCriterion in interface Eligible

Overrides:

defaultCriterion in class Event<T>

Returns:

the kind

See Also:

• Eligible.defaultCriterion()

isEligibleFor

public boolean isEligibleFor(Object criterion)

Returns true if the criterion is Event.class (representing “any event”) or if the criterion is a String equal to this event’s kind (the String passed to the constructor).

Specified by:

isEligibleFor in interface Eligible

Overrides:

isEligibleFor in class Event<T>

Parameters:

criterion - the criterion

Returns:

true if this meets the criterion

See Also:

• Eligible.isEligibleFor(java.lang.Object)

data

public Map<Object,Object> data()

Returns a map with data that belongs to the event.

The map is only created if requested. If a component uses NamedEvents and data that consists of JDK types only, it is completely loosely coupled.

Returns:

the map

toString

public String toString()

Overrides:

toString in class Event<T>