Package it.tidalwave.actor

Class MessageSupport

java.lang.Object

it.tidalwave.actor.MessageSupport

All Implemented Interfaces:

Collaboration.Provider, As, java.io.Serializable

Direct Known Subclasses:

CollaborationCompletedMessage, CollaborationStartedMessage

public abstract class MessageSupport
extends java.lang.Object
implements Collaboration.Provider, As, java.io.Serializable

A support class for implementing messages.

Author:

Fabrizio Giudici

See Also:

Serialized Form

Stereotype:

Message

Nested Class Summary

Nested classes/interfaces inherited from interface it.tidalwave.util.As

As.Type<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected it.tidalwave.actor.impl.DefaultCollaboration	collaboration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageSupport()
protected	MessageSupport(Collaboration collaboration)

Method Summary

Modifier and Type	Method	Description
Collaboration	getCollaboration()	Returns the Collaboration that this message is part of.
<T> java.util.Optional<T>	maybeAs(java.lang.Class<? extends T> type)	Returns the requested role or an empty Optional.
Collaboration	send()	Sends this message, eventually performing a replacement (see MessageDecorator for further info).
Collaboration	sendDirectly()	Sends this message directly, not performing any replacement (see MessageDecorator for further info).
Collaboration	sendLater(int delay, java.util.concurrent.TimeUnit timeUnit)	Sends this message after a delay, eventually performing a replacement (see MessageDecorator for further info).

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.tidalwave.util.As

as, as, asMany, asMany, maybeAs

Field Detail

collaboration

@Nonnull
protected final it.tidalwave.actor.impl.DefaultCollaboration collaboration

Constructor Detail

MessageSupport

protected MessageSupport()

MessageSupport

protected MessageSupport(@Nonnull
                         Collaboration collaboration)

Parameters:

collaboration - the collaboration

Method Detail

getCollaboration

@Nonnull
public Collaboration getCollaboration()

Returns the Collaboration that this message is part of.

Specified by:

getCollaboration in interface Collaboration.Provider

Returns:

the Collaboration

send

@Nonnull
public Collaboration send()

Sends this message, eventually performing a replacement (see MessageDecorator for further info).

Returns:

the Collaboration that this message is part of

sendDirectly

@Nonnull
public Collaboration sendDirectly()

Sends this message directly, not performing any replacement (see MessageDecorator for further info).

Returns:

the Collaboration that this message is part of

sendLater

@Nonnull
public Collaboration sendLater(@Nonnegative
                               int delay,
                               @Nonnull
                               java.util.concurrent.TimeUnit timeUnit)

Sends this message after a delay, eventually performing a replacement (see MessageDecorator for further info).

Parameters:

delay - the delay

timeUnit - the TimeUnit for the delay

Returns:

the Collaboration that this message is part of

maybeAs

@Nonnull
public <T> java.util.Optional<T> maybeAs(@Nonnull
                                         java.lang.Class<? extends T> type)

Returns the requested role or an empty Optional.

Specified by:

maybeAs in interface As

Type Parameters:

T - the static type

Parameters:

type - the dynamic type

Returns:

the optional role