Package org.jgrapes.core.internal

Class ActionEvent<T>

java.lang.Object

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

org.jgrapes.core.Event<T>

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

All Implemented Interfaces:

Future<T>, Associator, Eligible

public abstract class ActionEvent<T>
extends Event<T>

A base class for events that perform an action instead of being handled.

Use to synchronize some action with the other events on an EventPipeline.

Nested Class Summary

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

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name

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

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionEvent(String name)	Instantiates a new action event.

Method Summary

Modifier and Type	Method	Description
Object	defaultCriterion()	Returns the class of this event as representation of its kind.
boolean	isEligibleFor(Object criterion)	Returns true if the criterion is of the same class or a base class of this event’s class.
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

Field Details

name

protected String name

Constructor Details

ActionEvent

protected ActionEvent(String name)

Instantiates a new action event.

Parameters:

name - the name

Method Details

isEligibleFor

public boolean isEligibleFor(Object criterion)

Description copied from class: Event

Returns true if the criterion is of the same class or a base class of this event’s class.

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)

defaultCriterion

public Object defaultCriterion()

Description copied from class: Event

Returns the class of this event as representation of its kind.

Specified by:

defaultCriterion in interface Eligible

Overrides:

defaultCriterion in class Event<T>

Returns:

the class of this event

See Also:

• Eligible.defaultCriterion()

toString

public String toString()

Overrides:

toString in class Event<T>