public interface Broadcastable
Broadcaster
,
EmittingBroadcaster
,
Syntax
Modifier and Type | Method and Description |
---|---|
void |
propagateBroadcast(Broadcaster broadcaster,
Status status)
Broadcasts or rebroadcasts all child units using the given
Broadcaster . |
boolean |
shouldBreakBroadcast(SubscriptionPhase phase)
Gets whether an in-progress broadcast should be stopped.
|
Status |
status()
Gets the current broadcast status of this unit.
|
void |
status(Status status)
Sets the current broadcast status.
|
void status(Status status)
status
- The new status.Status status()
This primarily determines whether this unit should be broadcasted again.
void propagateBroadcast(Broadcaster broadcaster, Status status)
Broadcaster
.
The broadcast will only occur for a unit if its Status
matches the given Status
.
Implementers should call this on child units and SyntaxCollection
s first, then use the broadcaster to broadcast
itself. All of this should be wrapped in a check to ensure the Status
matches.
broadcaster
- Use this Broadcaster
to broadcast all unbroadcasted child units.status
- Broadcast units that have this status.boolean shouldBreakBroadcast(SubscriptionPhase phase)
This might be true if a change of state or conditions of the unit result in the broadcast no longer being necessary during
the given SubscriptionPhase
.
phase
- The current SubscriptionPhase
.Copyright (c) 2019, Salesforce.com, Inc. All rights reserved. Licensed under the BSD 3-Clause license. For full license text, see the LICENSE file in the repository.